Qui peut utiliser cette fonctionnalité ?
Disponible sur tous les plans Developer API.
Tous les membres
This article will guide you through the process of sending a document for signature using a template with the Sign.Plus eSignature API.
En suivant ces étapes, vous créez une enveloppe à partir d'un modèle, définissez les détails du destinataire et envoyez l'enveloppe pour la signature.
Pré-requis
- Un compte Sign.Plus avec un Plan API
- Your
Personal Access Token
- An existing template in your Sign.Plus account
É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.
- Remplacer
{template_id}
par l'ID de votre modèle existant.
Où puis-je trouver mon identifiant de modèle ?- Allez sur https://app.sign.plus/templates.
- Cliquez sur le nom du modèle désiré.
- Copiez l'ID dans la barre latérale droite.
- Allez sur https://app.sign.plus/templates.
- Envoyer une requête POST à
POST /v2/envelope/from_template/{template_id}
avec le corps JSON suivant :{
"name": "Ma merveilleuse enveloppe à partir du template"
} - Inclure votre clé API dans l'en-tête
Authorization
. - En cas de succès, vous recevrez
un objet Enveloppe
.{
"id": "66eb7d0467d2d549b89fcb6d",
// ...
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"uid": null,
"nom": "",
"email": "",
"rôle": "SIGNER",
"vérification": null
}
]
},
{
"destinataires": [
{
"id": "66eb7d0467d2d549b89fcb71",
"uid": null,
"nom": "",
"email": "",
"rôle": "RECEIVES_COPY",
"vérification": null
},
{
"id": "66eb7d0467d2d549b89fcb72",
"uid": null,
"nom": "",
"email": "",
"rôle": "SIGNER",
"vérification": null
}
]
}
],
"documents": [
// . .
],
"notification": {
// ...
}
} - Enregistrez l'
id
retourné commeenvelope_id
pour de futurs appels API. - Enregistrez l'
id
de chaque destinataire pour une utilisation ultérieure dans le processus de signature.
Exemples:-
66eb7d0467d2d549b89fcb71
: PremierSIGNER
(Étape 1) -
66eb7d0467d2d549b89fcb71
:RECEIVES_A_COPY
(Étape 1) -
66eb7d0467d2d549b89fcb72
: SecondeSIGNER
(Étape 2)
-
Étape 2 : Définir les coordonnées du destinataire
Si votre modèle n'a pas de destinataires fixes et que vous devez définir ou mettre à jour les détails du destinataire:
- Utilisez le point de terminaison POST /v2/envelope/{envelope_id}/signing_steps pour mettre à jour les informations du destinataire.
- Remplacez
{envelope_id}
par l'ID que vous avez reçu à l'étape 1. - Envoyer une requête
POST
avec le corps JSON suivant :{
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"nom": "Jean Doe",
"email": "john. oe@exemple. om",
"rôle": "SIGNER"
}
]
},
{
"destinataires": [
{
"id": "66eb7d0467d2d549b89fcb71",
"nom": "Mark Twain",
"email": "m. wain@exemple. om",
"rôle": "RECEIVES_COPY"
},
{
"id": "66eb7d0467d2d549b89fcb72",
"name": "Jane Smith",
"email": "j. mith@exemple. om",
"rôle": "SIGNER"
}
]
}
]
} - En cas de succès, vous recevrez un tableau d'objets
SigningStep
.
Étape 3 : Envoyez votre enveloppe pour signature
- Utilisez le point de terminaison POST /v2/envelope/{envelope_id}/send pour envoyer l'enveloppe.
- Remplacez
{envelope_id}
par votre ID d'enveloppe de l'étape 1. - Envoyer une requête
POST
à ce point de terminaison. - En cas de succès, l'enveloppe sera envoyée au ou aux destinataires pour la signature.
Conclusion
Vous avez maintenant envoyé avec succès un document pour signature en utilisant un modèle avec l'API eSignature Sign.Plus. Le ou les destinataires recevront une notification par courriel avec un lien pour signer le document.
L'utilisation de modèles permet de rationaliser considérablement le flux de travail de signature de vos documents, en particulier pour les documents fréquemment utilisés, avec des mises en page cohérentes et des exigences de signature.