Principe
L’utilisation de ce connecteur offre la possibilité d’intégrer un processus de signature électronique fourni par DocuSign. Ce connecteur s’appuie sur deux actions permettant de manipuler une enveloppe DocuSign à partir des informations suivantes :
Paramètre | Obligatoire | Description |
---|---|---|
baseUrl |
Oui | URL d’accès à DocuSign |
integratorKey |
Oui | Clé d’API permettant d’identifier l’application appelante |
username |
Oui | Identifiant de l’utilisateur |
password |
Oui | Mot de passe de l’utilisateur |
Nota : Le mot de passe peut être fourni sous la forme d’une chaîne de caractères chiffrée.
Création d’une enveloppe
Cette action permet la création et l’envoie d’une enveloppe DocuSign. Une enveloppe est constituée à partir de plusieurs informations :
Paramètre | Obligatoire | Description |
---|---|---|
template |
Oui | Identifiant du modèle DocuSign |
document |
Oui | Identifiant du document à signer |
recipientRole |
Oui | Rôle du signataire |
recipientEmail |
Oui | Adresse email du signataire |
recipientName |
Oui | Nom du signataire |
<bpmn2:serviceTask id="Activity_1vqoksu" camunda:modelerTemplate="docusign-request">
<bpmn2:extensionElements>
<camunda:connector>
<camunda:inputOutput>
<camunda:inputParameter name="baseUrl">https://demo.docusign.net/restapi</camunda:inputParameter>
<camunda:inputParameter name="username"></camunda:inputParameter>
<camunda:inputParameter name="password"></camunda:inputParameter>
<camunda:inputParameter name="recipientName"></camunda:inputParameter>
<camunda:inputParameter name="document"></camunda:inputParameter>
<camunda:inputParameter name="recipientEmail"></camunda:inputParameter>
<camunda:inputParameter name="recipientRole"></camunda:inputParameter>
<camunda:inputParameter name="template"></camunda:inputParameter>
<camunda:inputParameter name="integratorKey"></camunda:inputParameter>
<camunda:outputParameter name="envelopeId">${envelopeId}</camunda:outputParameter>
</camunda:inputOutput>
<camunda:connectorId>request-signature-docusign</camunda:connectorId>
</camunda:connector>
</bpmn2:extensionElements>
</bpmn2:serviceTask>
L’enveloppe est automatiquement envoyée à DocuSign pour procéder à la signature. Le signature recevra un email lui permettant de signer électroniquement le document soumis.
Suite à l’envoie de l’enveloppe, une réponse est retournée avec les informations issues de DocuSign :
Paramètre | Description |
---|---|
envelopeId |
Identifiant de l’enveloppe envoyée |
status |
Le statut de l’enveloppe envoyée |
statusDateTime |
Date à laquelle l’enveloppe a été envoyée |
uri |
URI permettant d’accéder à l’enveloppe |
errorDetails |
Détails d’une erreur potentielle |
Statut d’une enveloppe
Cette action permet de déterminer le statut d’une enveloppe DocuSign et de mettre à jour FlowerDocs.
Paramètre | Obligatoire | Description |
---|---|---|
envelopeId |
Oui | Identifiant de l’enveloppe DocuSign |
document |
Non | Identifiant du document à mettre à jour avec le document signé |
<bpmn2:serviceTask id="Activity_16qcrcd" camunda:modelerTemplate="docusign-handle">
<bpmn2:extensionElements>
<camunda:connector>
<camunda:inputOutput>
<camunda:inputParameter name="baseUrl">https://demo.docusign.net/restapi</camunda:inputParameter>
<camunda:inputParameter name="integratorKey"></camunda:inputParameter>
<camunda:inputParameter name="username"></camunda:inputParameter>
<camunda:inputParameter name="password"></camunda:inputParameter>
<camunda:inputParameter name="envelopeId">${envelopeId}</camunda:inputParameter>
<camunda:inputParameter name="document"></camunda:inputParameter>
<camunda:outputParameter name="certificate">${certificate}</camunda:outputParameter>
<camunda:outputParameter name="completedTime">${completedTime}</camunda:outputParameter>
<camunda:outputParameter name="status">${status}</camunda:outputParameter>
</camunda:inputOutput>
<camunda:connectorId>handle-signature-docusign</camunda:connectorId>
</camunda:connector>
</bpmn2:extensionElements>
</bpmn2:serviceTask>
Le statut de l’enveloppe est retourné dans le paramètre status
de la réponse. Lorsque l’enveloppe a été complétée, son statut a la valeur completed
et les informations suivantes sont ajoutées à la réponse :
Paramètre | Description |
---|---|
replaced |
Indique si le document à signer a été remplacé avec le document signé |
temporaryFile |
Identifiant du fichier temporaire créé si le contenu du document n’a pas été remplacé |
Si aucun identifiant de document n’est fourni, le document signé est stocké sous la forme d’un fichier temporaire dont l’identifiant est retourné dans la réponse d’appel au connecteur. Ce fichier temporaire peut, par la suite, être utilisé pour créer un nouveau document.