Qui peut utiliser cette fonctionnalité ?
Disponible sur tous les plans Developer API.
Tous les membres
This article will walk you through the process of sending a document for signature using the Sign.Plus eSignature API.
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 la signature.
Pré-requis
- Un compte Sign.Plus avec un Plan API
- Your
Personal Access Token
Étape 1 : Créer une enveloppe
Une enveloppe est un contenant pour les documents qui doivent être signés par les destinataires.
- Envoyez une demande au point de terminaison POST /v2/envelope pour créer une nouvelle enveloppe.
{
"name": "Ma merveilleuse enveloppe",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Inclure votre clé API dans l'en-tête
Authorization. -
En cas de succès, vous recevrez un objet
Enveloppe.{ "id": "<string>" ... } -
Enregistrer
idcomme l'enveloppe
É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 que vous avez reçu à l'étape 1. - Envoyer une requête POST avec le fichier document dans le corps de la requête comme
multipart/form-data. -
En cas de succès, vous recevrez un objet
Documentcomme réponse.{ "id": "<string>" ... } -
Enregistrez l'
iden tant quedocument_idpour plus tard.
Étape 3 : Définissez 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 votre identifiant d'enveloppe. -
Envoyer une requête
POSTavec le corps JSON suivant:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john. oe@exemple. om", "rôle": "SIGNER"
} ] } ] } -
En cas de succès, vous recevrez un tableau de
SigninStep. -
Parcourez le tableau et prenez le nom
iddu destinataire pour lequel vous souhaitez ajouter le cadre de signature (annotation de signatures). Enregistrez cetteiden tant querecipient_id.
Étape 4 : Insérez une annotation de signature dans votre document
Avant d'ajouter une annotation de signature, assurez-vous que vous avez défini votre signature dans 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 votre identifiant d'enveloppe. - Envoyer 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 : 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 identifiant d'enveloppe. - Envoyer une requête
POSTà ce point de terminaison. - En cas de succès, l'enveloppe sera envoyée au destinataire pour la signature.
Conclusion
Vous avez maintenant envoyé avec succès un document pour signature en utilisant l'API Sign.Plus eSignature. Le destinataire recevra une notification par courriel avec un lien pour signer le document.
Pour des informations plus détaillées sur chaque point de terminaison de l'API utilisé dans ce processus, veuillez vous référer à notre documentation API.