Application de workflow ADOBESIGNSEND
L'application de workflow ADOBESIGNSEND vous permet d'envoyer un ou plusieurs documents à Adobe Sign pour signature électronique.
- L'application ADOBESIGNSEND crée une enveloppe unique et l'envoie à un ou plusieurs signataires.
- Vous pouvez spécifier un ou plusieurs fichiers par action ADOBESIGNSEND. Pour ce faire, utilisez le paramètre
FILEx, oùxcorrespond 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_NAME_LISTetSIGNER_EMAIL_LIST. Vous pouvez également utiliserSIGNER_NAMExetSIGNER_EMAILx, oùxcorrespond au numéro du signataire. - Vous pouvez spécifier un rôle par destinataire. Pour ce faire, selon la méthode que vous utilisez pour spécifier les signataires (avec ou sans
_LIST), vous pouvez utiliserSIGNER_ROLE_LISTouSIGNER_ROLEx, oùxcorrespond au numéro du signataire. Valeurs possibles :SIGNER(par défaut),APPROVER,ACCEPTOR,CERTIFIED_RECIPIENT,FORM_FILLERouDELEGATE_TO_SIGNER,DELEGATE_TO_APPROVER,DELEGATE_TO_ACCEPTOR,DELEGATE_TO_CERTIFIED_RECIPIENT,DELEGATE_TO_FORM_FILLERouSHARE. - Des logs d'application sont disponibles. Ceux-ci peuvent être spécifiés en définissant la valeur du paramètre
AdobeSignSendLogLeveldans le fichierweb.configsur0pour désactiver la journalisation,1pour les logs d'erreur,2pour des logs d'informations ou3pour les logs de débogage; la valeur par défaut est0.
- 1.Dans l'interface d'administration Adobe Sign, ajoutez une nouvelle
API Applicationpuis cliquez sur Configure OAuth for application. - 2.Activez les portées ci-dessous et sélectionnez
accountsous Modifier pour les deux :agreement_writeagreement_read
- 3.Vous pouvez récupérer les
Client IDetClient Secretdirectement depuis l'onglet de configuration. - 4.Insérez une adresse valide dans le champ Redirect URI; elle sera utile pour l'étape suivante.
Configuration OAuth de l'application
Adobe Sign ne supportant pas l'authentification
client_credentials, il est nécessaire d'utiliser un jeton de rafraîchissement afin de récupérer un access_token valide. Le jeton de rafraîchissement à une durée de validité de 60 jours. Ces 60 jours sont renouvelés à chaque appel d'API, ce qui signifie que lorsque vous exécutez ADOBESIGNSEND ou ADOBESIGNCHECK, la validité est prolongé de 60 jours.Afin de pouvoir utiliser votre nouvelle application Adobe Sign, vous devez l'autoriser à accéder aux
scopes définis. Vous devez executer l'URL ci-dessous dans votre navigateur :<HOST_SERVER>/public/oauth?redirect_uri=<REDIRECT_URI>&client_id=<CLIENT_ID>&response_type=code&scope=agreement_read:account+agreement_send:account
Remplacez les informations ci-dessous par vos propres valeurs :
<HOST_SERVER>: Serveur hôte de votre compte Adobe Sign. En général l'URL est composée ainsi :https://api.naX.adobesign.com, oùXest l'identifiant du serveur.<REDIRECT_URI>: URL que vous avez définie dans votre application Adobe Sign.<CLIENT_ID>: Identifiant client de votre application Adobe Sign
Après avoir accordé le consentement à votre application, vous serez redirigé vers votre
REDIRECT_URI avec un paramètre CODE dans l'URL. <HOST_SERVER>/public/oauth?redirect_uri=<REDIRECT_URI>&client_id=<CLIENT_ID>&response_type=code&scope=agreement_read:account+agreement_send:account
Le code ainsi retourné par Adobe Sign est à usage unique et sera utilisé pour obtenir le jeton de rafraîchissement.
Afin d'obtenir le jeton de rafraîchissement, exécutez la requête ci-dessous en indiquant vos valeurs :
curl --location --request POST '<HOST_SERVER>/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'code=<CONSENT_CODE>' \
--data-urlencode 'client_id=<CLIENT_ID>' \
--data-urlencode 'client_secret=<CLIENT_SECRET>' \
--data-urlencode 'redirect_uri=<REDIRECT_URI>' \
--data-urlencode 'grant_type=authorization_code'
HOST_SERVER: Serveur hôte de votre compte Adobe Sign. En général l'URL est composé ainsi :https://api.naX.adobesign.com, oùXest l'identifiant du serveur.<CONSENT_CODE>: Code à usage unique obtenu sur l'étape précédente (Consentement et obtention du code à usage unique).<CLIENT_ID>: Identifiant client de votre application Adobe Sign.<CLIENT_SECRET>: Clé secrète client de votre application Adobe Sign.<REDIRECT_URI>: URL que vous avez définie dans votre application Adobe Sign.
Après exécution de la requête, vous obtiendrez une valeur pour le jeton de rafraîchissement contenu dans la donnée
refresh_token. Si votre jeton de rafraîchissement est expiré, vous devrez effectuer les manipulations précédentes de nouveau.
Vous pouvez utiliser l'une des configurations suivantes : avec une liste de signataires ou avec des numéros de signataires.
Paramètre | Type | Direction | Description |
SIGNER_NAME_LIST | TEXT | IN | Noms 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 |
Paramètre | Type | Direction | Description |
SIGNER_NAMEx | TEXT | IN | Nom(s) 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 | Type | Direction | Description |
ADOBESIGN_CLIENT_ID | TEXT | IN | ID client Adobe Sign
Par défaut, cette valeur provient du paramètre AdobeSignClientId dans le fichier web.config. |
ADOBESIGN_CLIENT_SECRET | TEXT | IN | Clé secrète client Adobe Sign
Par défaut, cette valeur provient du paramètre AdobeSignClientSecret dans le fichier web.config. |
ADOBESIGN_REFRESH_TOKEN | TEXT | IN | Jeton de rafraîchissement de l'authentification Par défaut, cette valeur provient du paramètre AdobeSignAuthServer dans le fichier web.config. |
ADOBESIGN_HOST_SERVER | TEXT | IN | Serveur hôte Adobe Sign (p.ex. : https://api.naX.adobesign.com, où X est l'identifiant du serveur)
Par défaut, cette valeur provient du paramètre AdobeSignHostServer dans le fichier web.config. |
Paramètres | Type | Direction | Description |
DATA_SEPARATOR | TEXT | IN | Séparateur utilisé pour séparer les contenus de SIGNERS_NAME_LIST, SIGNERS_EMAIL_LIST et SIGNER_ROLE_LIST
Par défaut : , (virgule) |
SIGNER_ROLE_LIST | TEXT | IN | Rôles des signataires, séparés par la valeur définie dans le paramètre DATA_SEPARATOR |
SIGNER_ROLEX | TEXT | IN | Rôle(s) du ou des signataires, où x correspond au numéro du signataire; vous pouvez ajouter un ou plusieurs signataires |
AGREEMENT_NAME | TEXT | IN | Nom de l'agrément, il sera affiché dans l'email envoyé à l'utilisateur
Par défaut : WorkflowGen |
Paramètre | Type | Direction | Description |
ADOBESIGN_AGREEMENT_ID | TEXT | OUT | Contient l'ID de l'agrément Adobe Sign; vous pouvez utiliser cet ID dans l'application de workflow ADOBESIGNCHECK |
Paramètre | Type | Direction | Valeur |
SIGNER_NAME_LIST | TEXT | IN | Jean Dupont,Bernard Martin |
SIGNER_EMAIL_LIST | TEXT | IN | |
SIGNER_ROLE_LIST | TEXT | IN | APPROVER,SIGNER |
FILE1 | FILE | IN | contrat.pdf |
ADOBESIGN_AGREEMENT_ID | TEXT | OUT | xxxxx-xxxxx-xxxxx-xxxxx |
Paramètre | Type | Direction | Valeur |
SIGNER_NAME1 | TEXT | IN | Jean Dupont |
SIGNER_NAME2 | TEXT | IN | Bernard Martin |
SIGNER_EMAIL1 | TEXT | IN | |
SIGNER_EMAIL2 | TEXT | IN | |
SIGNER_ROLE1 | TEXT | IN | APPROVER |
SIGNER_ROLE2 | TEXT | IN | SIGNER |
FILE1 | FILE | IN | contrat.pdf |
ADOBESIGN_AGREEMENT_ID | TEXT | OUT | xxxxx-xxxxx-xxxxx-xxxxx |
Dernière mise à jour 9mo ago