Application de workflow YOUSIGNSEND

Aperçu

L'application de workflow YOUSIGNSEND vous permet d'envoyer un ou plusieurs documents à Yousign pour signature électronique.

Mode de fonctionnement

• L'application YOUSIGNSEND crée une enveloppe unique et l'envoie à un ou plusieurs signataires.

• Vous pouvez spécifier un ou plusieurs fichiers par action YOUSIGNSEND. Pour ce faire, utilisez le paramètre FILEx, où x correspond au numéro de fichier (p.ex. : FILE1). Au moins un fichier est requis.

• Vous pouvez spécifier un ou plusieurs signataires. Pour ce faire, utilisez la combinaison de SIGNER_FIRSTNAME_LIST , SIGNER_LASTNAME_LIST et SIGNER_EMAIL_LIST. Vous pouvez également utiliser SIGNER_FIRSTNAMEx , SIGNER_LASTNAMEx et SIGNER_EMAILx, où x correspond au numéro du signataire.

• Des logs d'application sont disponibles. Ceux-ci peuvent être spécifiés en définissant la valeur du paramètre YousignSendLogLevel dans le fichier web.config sur 0 pour désactiver la journalisation, 1 pour les logs d'erreur, 2 pour des logs d'informations ou 3 pour les logs de débogage; la valeur par défaut est 0.

Configuration de l'API Yousign

Création d'une application API Yousign

1. Dans l'interface d'administration Yousign, cliquez sur l'onglet Intégrations, puis sélectionnez le menu API.
2. Cliquez sur le bouton Créer une nouvelle clé.

   

3. Entrez une description dans le champ Description. Sélectionnez un environnement (qui dépend de votre utilisation), puis sélectionnez les permissions Full-Access.

   

Paramètres requis

Vous pouvez utiliser l'une des configurations suivantes : avec une liste de signataires ou avec des numéros de signataires.

Avec une liste de signataires

Paramètre	Type	Direction	Description
SIGNER_FIRSTNAME_LIST	TEXT	IN	Prénoms des signataires, séparés par la valeur définie dans le paramètre DATA_SEPARATOR
SIGNER_FIRSTNAME_LIST	TEXT	IN	Noms de famille des signataires, séparés par la valeur définie dans le paramètre DATA_SEPARATOR
SIGNER_EMAIL_LIST	TEXT	IN	Adresses email des signataires, séparées par la valeur définie dans le paramètre DATA_SEPARATOR
FILEx	FILE	IN	Fichier(s) à envoyer, où x correspond au numéro de fichier; vous pouvez ajouter un ou plusieurs fichiers

Avec des numéros de signataires

Paramètre	Type	Direction	Description
SIGNER_FIRSTNAMEx	TEXT	IN	Prénom(s) du ou des signataires, où x correspond au numéro du signataire; vous pouvez ajouter un ou plusieurs signataires
SIGNER_LASTNAMEx	TEXT	IN	Nom(s) de famille du ou des signataires, où x correspond au numéro du signataire; vous pouvez ajouter un ou plusieurs signataires
SIGNER_EMAILx	TEXT	IN	Adresse(s) email du ou des signataires, où x correspond au numéro du signataire; vous pouvez ajouter un ou plusieurs signataires
FILEx	FILE	IN	Fichier(s) à envoyer, où x correspond au numéro de fichier; vous pouvez ajouter un ou plusieurs fichiers

Paramètres facultatifs

Configuration Yousign

Paramètres	Type	Direction	Description
YOUSIGN_API_KEY	TEXT	IN	Clé d'API Yousign Par défaut, cette valeur provient du paramètre YousignApiKey dans le fichier web.config.
YOUSIGN_HOST_SERVER	TEXT	IN	Serveur hôte Yousign (p.ex. : https://api.yousign.app/v3) Par défaut, cette valeur provient du paramètre YousignHostServer dans le fichier web.config.

Général

Paramètres	Type	Direction	Description
DATA_SEPARATOR	TEXT	IN	Séparateur utilisé pour séparer les contenus de SIGNER_FIRSTNAME_LIST, SIGNER_LASTNAME_LIST, SIGNER_EMAIL_LIST , SIGNER_PAGE_LIST, , SIGNER_X_POSITION_LIST, SIGNER_Y_POSTION_LIST , SIGNER_PHONE_LIST , SIGNER_LOCAL_LIST et SIGNER_AUTH_MODE_LIST Par défaut : , (virgule)
SIGNER_PAGE_LIST	TEXT	IN	Page à signer par le ou les signataire(s), séparés par la valeur définie dans le paramètre DATA_SEPARATOR
SIGNER_PAGEX	TEXT	IN	Page à signer par le signataire, où x correspond au numéro du signataire; vous pouvez ajouter un ou plusieurs signataires
SIGNER_X_POSITION_LIST	TEXT	IN	Position en X de la zone de signature pour le signataire, séparés par la valeur définie dans le paramètre DATA_SEPARATOR La valeur doit être un entier numérique positif.
SIGNER_X_POSITIONX	TEXT	IN	Position en X de la zone de signature pour le signataire, où x correspond au numéro du signataire La valeur doit être un entier numérique positif.
SIGNER_Y_POSITION_LIST	TEXT	IN	Position en Y de la zone de signature pour le signataire, séparés par la valeur définie dans le paramètre DATA_SEPARATOR La valeur doit être un entier numérique positif.
SIGNER_Y_POSITIONX	TEXT	IN	Position en Y de la zone de signature pour le signataire, où x correspond au numéro du signataire La valeur doit être un entier numérique positif.
SIGNATURE_NAME	TEXT	IN	Nom de la requête de signature.
SIGNER_PHONE_LIST	TEXT	IN	Numéro de téléphone du ou des signataire(s), séparés par la valeur définie dans le paramètre DATA_SEPARATOR
SIGNER_PHONEX	TEXT	IN	Numéro de téléphone du signataire, où x correspond au numéro du signataire.
SIGNER_LOCALE_LIST	TEXT	IN	Lieu du ou des signataire(s), séparés par la valeur définie dans le paramètre DATA_SEPARATOR
SIGNER_LOCALEX	TEXT	IN	Lieu du signataire, où x correspond au numéro du signataire.
SIGNER_AUTH_MODE_LIST	TEXT	IN	Mode d'authentification du ou des signataire(s), séparés par la valeur définie dans le paramètre DATA_SEPARATOR
SIGNER_AUTH_MODEX	TEXT	IN	Mode d'authentification du signataire, où x correspond au numéro du signataire Par défaut : no_otp
FILE_NATUREX	TEXT	IN	Nature du document du fichier à envoyer, où x correspond au numéro du signataire Par défaut : signable_document
SIGNATURE_WIDTH	TEXT	IN	Largeur du champ de signature Par défaut : 25
SIGNATURE_HEIGHT	TEXT	IN	Hauteur du champ de signature Par défaut : 37

Paramètre de retour

Paramètre	Type	Direction	Description
YOUSIGN_SIGNATURE_ID	TEXT	OUT	Contient l'ID de signature Yousign; Vous pouvez utiliser cet ID dans l'application de workflow YOUSIGNCHECK

Exemples

Avec liste de signataires

Paramètre	Type	Direction	Valeur
SIGNER_FIRSTNAME_LIST	TEXT	IN	Jean,Bernard
SIGNER_FIRSTNAME_LIST	TEXT	IN	Dupont,Martin
SIGNER_EMAIL_LIST	TEXT	IN	[e-mail],[e-mail]
SIGNATURE_NAME	TEXT	IN	Signature pour un contrat
SIGNER_PAGE_LIST	TEXT	IN	1,2
SIGNER_X_POSITION_LIST	TEXT	IN	100,100
SIGNER_Y_POSITION_LIST	TEXT	IN	100,100
FILE1	FILE	IN	contrat.pdf
YOUSIGN_SIGNATURE_ID	TEXT	OUT	xxxxx-xxxxx-xxxxx-xxxxx

Avec numéros de signataire

Paramètre	Type	Direction	Valeur
SIGNER_FIRSTNAME1	TEXT	IN	Jean
SIGNER_LASTNAME1	TEXT	IN	Dupont
SIGNER_FIRSTNAME2	TEXT	IN	Bernard
SIGNER_LASTNAME2	TEXT	IN	Martin
SIGNER_EMAIL1	TEXT	IN	[e-mail]
SIGNER_EMAIL2	TEXT	IN	[e-mail]
SIGNATURE_NAME	TEXT	IN	Signature pour un contrat
SIGNER_PAGE1	TEXT	IN	1
SIGNER_PAGE2	TEXT	IN	2
SIGNER_X_POSITION1	TEXT	IN	100
SIGNER_X_POSITION2	TEXT	IN	100
SIGNER_Y_POSITION1	TEXT	IN	100
SIGNER_Y_POSITION2	TEXT	IN	100
FILE1	FILE	IN	contrat.pdf
YOUSIGN_SIGNATURE_ID	TEXT	OUT	xxxxx-xxxxx-xxxxx-xxxxx