Application de workflow YOUSIGNCHECK
Aperçu
L'application de workflow YOUSIGNCHECK vous permet de vérifier le statut d'un agrément et de télécharger son fichier associé, qui est une concaténation de fichiers joints.
Mode de fonctionnement
Vous pouvez vérifier le statut d'un agrément et télécharger le fichier depuis Yousign en fonction de vos critères de statut.
Des logs d'application sont disponibles. Ceux-ci peuvent être spécifiés en définissant la valeur du paramètre
YousignCheckLogLevel
dans le fichierweb.config
sur0
pour désactiver la journalisation,1
pour les logs d'erreur,2
pour des logs d'informations ou3
pour les logs de débogage; la valeur par défaut est0
.
Configuration de l'API Yousign
Pour configurer l'API Yousign, référez-vous à la section Configuration de l'API Yousign dans la section Application de workflow YOUSIGNSEND.
Paramètre requis
Paramètre
Type
Direction
Description
YOUSIGN_SIGNATURE_ID
TEXT
IN
ID de la signature Yousign à vérifier
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
VALID_STATUS_LIST
TEXT
IN
Statut valide pour télécharger le document
Valeurs possibles :
draft
ongoing
done
deleted
expired
canceled
approval
rejected
declined
Par défaut : done,canceled,expired,deleted,rejected
YOUSIGN_DOCUMENT
FILE
OUT
Document Yousign
YOUSIGN_STATUS
TEXT
OUT
Statut de l'agrément
Exemple avec YOUSIGNSEND
Dans l'exemple suivant, l'action YOUSIGNSEND est directement suivie par l'action YOUSIGNCHECK. Cette action reviendra sur elle-même jusqu'à ce que le statut passe à done
, canceled
, expired
, deleted
ou rejected
.
Si le statut renvoyé remplit la condition, le document sera téléchargé à partir de Yousign.
Avec la fonction d'action de boucle système, l'action YOUSIGNCHECK sera exécutée toutes les x
secondes jusqu'à ce que la condition OUT soit remplie.