Explications fonctionnelles

Intégrer l'API REST Yousign

Créer ma première procédure de signature via l'API

La création d'une nouvelle procédure de signature avec notre nouvelle API REST Yousign va s'effectuer en 2 étapes principales :

  1. L'envoi des documents PDF à signer chez Yousign
  2. La création de la procédure de signature

Nous effectuons désormais cette opération en 2 étapes dans un souci de performances et pour permettre notamment à nos clients d'envoyer des documents PDF plus volumineux.

 

Envoi des documents PDF à signer

Schéma

Int_grer_l_API_REST_Yousign_-_Step_01.png

Il convient de répéter cette étape autant de fois que vous avez de documents à signer.

A noter que dans ce cas, les documents seront présentés par défaut dans la procédure de signature dans l'ordre dans laquelle ils ont été uploadés via l'API.

Développement

Pour les détails techniques de cette étape, vous pouvez consulter l'article Envoyer un document PDF à Yousign.

Votre document est désormais envoyé chez Yousign. Voyons maintenant comment inviter un signataire à signer ce document en créant une procédure de signature.

 

Création de la procédure de signature

Maintenant que nous disposons de l'ID du fichier précédemment envoyé, nous allons pouvoir l'utiliser dans la création de notre procédure de signature.

Schéma

Int_grer_l_API_REST_Yousign_-_Step_2.png

 

L'ID du fichier sera à passer dans le tableau des "fileObjects" pour la clé nommée "file". Les "fileObjects" seront liés aux "members", c'est-à-dire aux membres de la procédure (signataires ou validateurs).

Développement

Pour les détails techniques de cette étape, vous pouvez consulter l'article Créer une procédure de signature.

Félicitation, votre première procédure de signature est créée via l'API !

 

 

Vérifications dans l'application Yousign

Afin de retrouver la procédure que nous venons de créer au sein de l'application Yousign, il suffit de se rendre dans le menu Signature > Toutes. Les procédures créées via API n'ont pas de créateur associé (en tant qu'utilisateur de l'application).

Voici en première ligne la procédure que nous avons créé ensemble :

Int_grer_l_API_REST_Yousign_-_Step_02_-_Webapp.png

De plus, un e-mail a été envoyé sur l'adresse du signataire pour l'inviter à accéder aux documents à signer :

Int_grer_l_API_REST_Yousign_-_Step_02_-_E-mail.png

Vous pouvez dès à présent passer articles suivants pour découvrir de nouveaux cas d'usages et de nouvelles fonctionnalités.

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0