# 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.<br>
* 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.<br>
* 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.<br>
* 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**.\
   ![](https://content.gitbook.com/content/pSR0FJub3VUec6MbQZNw/blobs/L9cf2BTEBhIjpLYkG2oZ/image.png)<br>

2. Cliquez sur le bouton **Créer une nouvelle clé**.

   <figure><img src="https://content.gitbook.com/content/pSR0FJub3VUec6MbQZNw/blobs/2GVGmhEHVu07qFCiy4CD/image.png" alt=""><figcaption></figcaption></figure>

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**.

   <div align="left"><figure><img src="https://content.gitbook.com/content/pSR0FJub3VUec6MbQZNw/blobs/Q9njw0MkfHkT2zQssKNl/image.png" alt=""><figcaption></figcaption></figure></div>

## 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            | <p>Clé d'API Yousign<br><br>Par défaut, cette valeur provient du paramètre <code>YousignApiKey</code> dans le fichier <code>web.config</code>.</p>                                                                |
| `YOUSIGN_HOST_SERVER` | TEXT     | IN            | <p>Serveur hôte Yousign (p.ex. :  <code><https://api.yousign.app/v3></code>)<br></p><p>Par défaut, cette valeur provient du paramètre <code>YousignHostServer</code> dans le fichier <code>web.config</code>.</p> |

### Général

| **Paramètres**           | **Type** | **Direction** | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ------------------------ | -------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `DATA_SEPARATOR`         | TEXT     | IN            | <p>Séparateur utilisé pour séparer les contenus de <code>SIGNER\_FIRSTNAME\_LIST</code>, <code>SIGNER\_LASTNAME\_LIST</code>, <code>SIGNER\_EMAIL\_LIST</code> , <code>SIGNER\_PAGE\_LIST</code>, , <code>SIGNER\_X\_POSITION\_LIST</code>, <code>SIGNER\_Y\_POSTION\_LIST</code> , <code>SIGNER\_PHONE\_LIST</code> , <code>SIGNER\_LOCAL\_LIST</code> et <code>SIGNER\_AUTH\_MODE\_LIST</code> <br><strong>Par défaut :</strong> <code>,</code> (virgule)</p> |
| `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            | <p>Position en X de la zone de signature pour le signataire, séparés par la valeur définie dans le paramètre <code>DATA\_SEPARATOR</code> </p><p></p><p>La valeur doit être un entier numérique positif.</p>                                                                                                                                                                                                                                                    |
| `SIGNER_X_POSITIONX`     | TEXT     | IN            | <p>Position en X de la zone de signature pour le signataire, où <code>x</code> correspond au numéro du signataire </p><p></p><p>La valeur doit être un entier numérique positif.</p>                                                                                                                                                                                                                                                                            |
| `SIGNER_Y_POSITION_LIST` | TEXT     | IN            | <p>Position en Y de la zone de signature pour le signataire, séparés par la valeur définie dans le paramètre <code>DATA\_SEPARATOR</code> </p><p></p><p>La valeur doit être un entier numérique positif.</p>                                                                                                                                                                                                                                                    |
| `SIGNER_Y_POSITIONX`     | TEXT     | IN            | <p>Position en Y de la zone de signature pour le signataire, où <code>x</code> correspond au numéro du signataire </p><p></p><p>La valeur doit être un entier numérique positif.</p>                                                                                                                                                                                                                                                                            |
| `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            | <p>Mode d'authentification du signataire, où <code>x</code> correspond au numéro du signataire<br><br><strong>Par défaut :</strong> <code>no\_otp</code> </p>                                                                                                                                                                                                                                                                                                   |
| `FILE_NATUREX`           | TEXT     | IN            | <p>Nature du document du fichier à envoyer, où <code>x</code> correspond au numéro du signataire<br><br><strong>Par défaut :</strong> <code>signable\_document</code></p>                                                                                                                                                                                                                                                                                       |
| `SIGNATURE_WIDTH`        | TEXT     | IN            | <p>Largeur du champ de signature<br><br><strong>Par défaut :</strong> <code>25</code></p>                                                                                                                                                                                                                                                                                                                                                                       |
| `SIGNATURE_HEIGHT`       | TEXT     | IN            | <p>Hauteur du champ de signature<br><br><strong>Par défaut :</strong> <code>37</code></p>                                                                                                                                                                                                                                                                                                                                                                       |

### Paramètre de retour

| **Paramètre**          | **Type** | **Direction** | **Description**                                                                                                                                                                  |
| ---------------------- | -------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `YOUSIGN_SIGNATURE_ID` | TEXT     | OUT           | <p>Contient l'ID de signature Yousign; </p><p>Vous pouvez utiliser cet ID dans l'application de workflow <a href="application-de-workflow-adobesigncheck-1">YOUSIGNCHECK</a></p> |

## 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            | `jean.dupont@email.fr,bernard.martin@email.fr` |
| `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            | `jean.dupont@email.fr`      |
| `SIGNER_EMAIL2`        | TEXT     | IN            | `bernard.martin@email.fr`   |
| `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`   |
