Qui peut utiliser cette fonctionnalité ?
Disponible sur tous les plans Developer API.
Tous les membres
Cet article vous explique comment envoyer un document pour signature à partir d'un modèle avec l'API eSignature de Sign.Plus.
En suivant ces étapes, vous créerez une enveloppe à partir d'un modèle, définirez les informations des destinataires, puis enverrez l'enveloppe pour signature.
Prérequis
- Un compte Sign.Plus avec un plan API
- Votre
Personal Access Token - Un modèle existant dans votre compte Sign.Plus
Étape 1 : créer une enveloppe à partir d'un modèle
- Utilisez le point de terminaison POST /v2/envelope/from_template/{template_id} pour créer une nouvelle enveloppe à partir d'un modèle.
- Remplacez
{template_id}par l'ID de votre modèle existant.
Où puis-je trouver l'ID de mon modèle ?- Accédez à https://app.sign.plus/templates .
- Cliquez sur le nom du modèle souhaité.
- Copiez l'ID depuis la barre latérale droite.
- Accédez à https://app.sign.plus/templates .
- Envoyez une requête POST à
POST /v2/envelope/from_template/{template_id}avec le corps JSON suivant :{"name": "My wonderful envelope from template"} - Incluez votre clé API dans l'en-tête
Authorization. - En cas de succès, vous recevrez
an Envelopeobjet.{"id": "66eb7d0467d2d549b89fcb6d",// ..."signing_steps": [{"recipients": [{"id": "66eb7d0467d2d549b89fcb70","uid": null,"name": "","email": "","role": "SIGNER","verification": null}]},{"recipients": [{"id": "66eb7d0467d2d549b89fcb71","uid": null,"name": "","email": "","role": "RECEIVES_COPY","verification": null},{"id": "66eb7d0467d2d549b89fcb72","uid": null,"name": "","email": "","role": "SIGNER","verification": null}]}],"documents": [// ...],"notification": {// ...}} - Enregistrez l'
idretourné en tant queenvelope_idpour de futurs appels API. - Notez l'
idde chaque destinataire pour l'utiliser plus tard dans le processus de signature.
Exemples :-
66eb7d0467d2d549b89fcb71: premierSIGNER(étape 1) -
66eb7d0467d2d549b89fcb71:RECEIVES_A_COPY(étape 1) -
66eb7d0467d2d549b89fcb72: deuxièmeSIGNER(étape 2)
-
Étape 2 : définir les informations des destinataires
Si votre modèle n'a pas de destinataires fixes et que vous devez définir ou mettre à jour leurs informations :
- Utilisez le point de terminaison POST /v2/envelope/{envelope_id}/signing_steps pour mettre à jour les informations des destinataires.
- Remplacez
{envelope_id}par l'ID que vous avez reçu à l'étape 1. - Envoyez une requête
POSTavec le corps JSON suivant :{
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"name": "John Doe",
"email": "john.doe@example.com",
"role": "SIGNER"
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"name": "Mark Twain",
"email": "m.twain@example.com",
"role": "RECEIVES_COPY"
},
{
"id": "66eb7d0467d2d549b89fcb72",
"name": "Jane Smith",
"email": "j.smith@example.com",
"role": "SIGNER"
}
]
}
]
} - En cas de succès, vous recevrez un tableau d'objets
SigningStep.
Étape 3 : 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 obtenu à l'étape 1. - Envoyez une requête
POSTvers ce point de terminaison. - En cas de succès, l'enveloppe sera envoyée au(x) destinataire(s) pour signature.
Conclusion
Vous avez maintenant envoyé avec succès un document pour signature à l'aide d'un modèle avec l'API eSignature de Sign.Plus. Les destinataires recevront une notification par e-mail contenant un lien pour signer le document.
L'utilisation de modèles peut considérablement simplifier votre processus de signature de documents, en particulier pour les documents fréquemment utilisés ayant une mise en page et des exigences de signature homogènes.