Qui peut utiliser cette fonctionnalité\u00a0?
Disponible sur tous les plans Developer API.
Tous les membres
Cet article vous explique comment envoyer un document pour signature à l'aide de l'API eSignature de Sign.Plus.
En suivant ces étapes, vous allez créer une enveloppe, ajouter un document, définir un destinataire, insérer une annotation de signature et, enfin, envoyer l'enveloppe pour signature.
Prérequis
- Un compte Sign.Plus avec un plan API
- Votre
Personal Access Token
Étape 1\u00a0: créer une enveloppe
Une enveloppe est un conteneur pour les documents à faire signer par les destinataires.
- Envoyez une requête au point de terminaison POST /v2/envelope pour créer une nouvelle enveloppe.
{
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Incluez votre clé API dans l'en-tête
Authorization. -
En cas de succès, vous recevrez un objet
Envelope.{ "id": "<string>" ... } -
Enregistrez l'
idcommeenvelope_id
Étape 2 : ajouter un document à votre enveloppe
-
Utilisez le point de terminaison POST /v2/envelope/{envelope_id}/document pour ajouter un document.
-
Remplacez
{envelope_id}par l'ID reçu à l'étape 1. - Envoyez une requête POST avec le fichier du document dans le corps de la requête au format
multipart/form-data. -
En cas de succès, vous recevrez un objet
Documenten réponse.{ "id": "<string>" ... } -
Enregistrez l'
idcommedocument_idpour plus tard.
Étape 3 : définir un destinataire pour votre enveloppe
-
Utilisez le point de terminaison POST /v2/envelope/{envelope_id}/signing_steps pour ajouter un destinataire.
-
Remplacez
{envelope_id}par l'ID de votre enveloppe. -
Envoyez une requête
POSTavec le corps JSON suivant :{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] } -
En cas de succès, vous recevrez un tableau de
SigninStep. -
Parcourez le tableau et notez le nom
iddu destinataire pour lequel vous souhaitez ajouter le cadre de signature (annotation de signature). Enregistrez cetidcommerecipient_id.
Étape 4 : insérer une annotation de signature dans votre document
Avant d'ajouter une annotation de signature, assurez-vous d'avoir défini votre signature sur la plateforme Sign.Plus.
- Utilisez le point de terminaison POST /v2/envelope/{envelope_id}/annotation pour ajouter une annotation de signature.
- Remplacez
{envelope_id}par l'ID de votre enveloppe. - Envoyez une requête
POSTavec le corps JSON suivant :{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}Remplacez
<recipient_id>et<document_id>par les valeurs appropriées.
Étape 5 : envoyer votre enveloppe pour signature
- Utilisez le point de terminaison POST /v2/envelope/{envelope_id}/send pour envoyer l'enveloppe.
- Remplacez
{envelope_id}par l'ID de votre enveloppe. - Envoyez une requête
POSTà ce point de terminaison. - En cas de succès, l'enveloppe sera envoyée au destinataire pour signature.
Conclusion
Vous avez maintenant envoyé avec succès un document pour signature à l'aide de l'API eSignature de Sign.Plus. Le destinataire recevra une notification par e-mail contenant un lien pour signer le document.
Pour obtenir des informations plus détaillées sur chaque point de terminaison de l'API utilisé dans ce processus, veuillez consulter notre documentation de l'API.