> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/produit/efalia-process/integrations/contrat-prive.md).

# Contrat Privé

## Sommaire

Le but de ce document est de fournir les informations nécessaires à la mise en oeuvre du service de signature **Contrat Privé** à l'aide des connecteurs ad hoc. Ces connecteurs sont natifs à Process et ne nécessitent pas d'intervention particulière, toutefois ils y sont présents que depuis la version `6.36.0`. [Contrat Privé](https://www.contrat-prive.com) est un service de signature fourni par [Efalia](https://www.efalia.com).

## Configuration

Dans l'administration du Panorama, il faut spécifier les 3 paramètres de configuration sans omettre l'activation du service.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-bef69279ef195ed2dcbd662e3c9f18bf8b3570ef%2Fprocess-contrat-prive-contrat-prive-conf.webp?alt=media" alt=""><figcaption></figcaption></figure>

## Usage

### Connecteur CreateContractConnector

Ce connecteur permet la création d'un nouveau contrat *Contrat Privé*.

* **Classe du connecteur**: `com.clog.workey.sign.contratprive.connectors.CreateContractConnector`
* **Paramètres en entrée**:
  * **jsonMapping**: JSON détaillant le mapping entre les champs du formulaire et les données utilisée par Contrat Privé (voir ci-dessous).
  * **jsonStamper**: JSON issu du composant `Signataires et cachets`. Il est optionnel mais s'il est spécifié, le positionnement du cachet y est récupéré au détriment de celui présent dans le paramètre `jsonMapping`. Par contre son utilisation ne peut concerner q'un seul document pour un seul signataire.
* **Paramètres en sortie**:
  * **publicId**: Référence publique du contrat
  * **signatoriesPublicId**: Référence publique des signataires

### Connecteur CheckContractConnector

Ce connecteur permet la vérification de l'état d'un contrat existant, et la recopie des documents signés le cas échéant.

* **Classe du connecteur**: `com.clog.workey.sign.contratprive.connectors.CheckContractConnector`
* **Paramètres en entrée**:
  * **jsonMapping**: JSON détaillant le mapping entre les champs du formulaire et les données utilisée par Contrat Privé (voir ci-dessous).
  * **publicId**: Référence publique du contrat
* **Paramètres en sortie**:
  * **contractStatus**: Etat du contrat (`canceled`, `closed`, `deleted`, `draft`, `expired`, `submited` ou `suspended`)
  * **signedUUID**: UUIDs des pièces-jointes des documents signés.

## Déclaration des champs

Par défaut, les champs du formulaire nommés `ContratPrive_{key}` sont utilisés pour les correspondances. Les propriétés JSON dont le nom est en gras (par ex, **title**), sont obligatoires.

Pour plus de détails sur le fonctionnement de l'API Contrat-Privé, se référer à la \[[documentation technique](https://sandbox.contrat-prive.com/fr/product/api_doc)].

### Contrat

| Propriété JSON        | Description                                                                                                                                                           | Champ par défaut                |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| **title**             | Titre du contrat.                                                                                                                                                     | ContratPrive\_title             |
| **language**          | Langue du contrat.                                                                                                                                                    | ContratPrive\_language          |
| **signatureRequired** | Caractère obligatoire des signatures.                                                                                                                                 | ContratPrive\_signatureRequired |
| type                  | Type de contrat. Les valeurs possibles sont `custom` (par défaut), `classique`, `devis_mono`, `devis_bi`, `emargement`, `travail`, `location`, `assurance` ou `horo`. | ContratPrive\_type              |
| signDueDate           | Date limite de signature, doit être dans le futur.                                                                                                                    | ContratPrive\_signDueDate       |
| autoClosingDate       | Date de clôture automatique, doit être dans le futur.                                                                                                                 | ContratPrive\_autoClosingDate   |
| signPage              | Ajout d'une page de signature (`true` par défaut).                                                                                                                    | ContratPrive\_signPage          |
| **action**            | Si `true` soumet à signature le contrat, si `false` le contrat est enregistré en brouillon.                                                                           | ContratPrive\_action            |

### Documents

| Propriété JSON | Description         | Champ par défaut         |
| -------------- | ------------------- | ------------------------ |
| **documents**  | Documents à signer. | ContratPrive\_documents  |
| appendices     | Documents annexes.  | ContratPrive\_appendices |

### Signataires

| Propriété JSON          | Description                                                                                                                 | Champ par défaut                    |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| **signatoryExternalId** | Référence externe du signataire dans le SI client.                                                                          | ContratPrive\_signatoryExternalId   |
| **signatoryFirstname**  | Prénom du signataire.                                                                                                       | ContratPrive\_signatoryFirstname    |
| **signatoryLastname**   | Nom de famille du signataire.                                                                                               | ContratPrive\_signatoryLastname     |
| **signatoryEmail**      | Email du signataire.                                                                                                        | ContratPrive\_signatoryEmail        |
| **signatoryPhone**      | Numéro de téléphone portable du signataire.                                                                                 | ContratPrive\_signatoryPhone        |
| signatoryPayment        | Montant de l'acompte que doit payer le signataire. Le montant doit être exprimé en centime et être compris entre 0 et 50000 | ContratPrive\_signatoryPayment      |
| signatoryOrganization   | Nom de l'entreprise du signataire.                                                                                          | ContratPrive\_signatoryOrganization |

### Positions des signatures

Il existe trois manières différentes de définir les emplacements de signatures. Chaque méthode est exclusive aux autres.

#### Quatre champs multivalués pour chaque paramètre

| Propriété JSON | Champ par défaut            |
| -------------- | --------------------------- |
| signatoryPage  | ContratPrive\_signatoryPage |
| signatoryX1    | ContratPrive\_signatoryX1   |
| signatoryY1    | ContratPrive\_signatoryY1   |
| signatoryX2    | ContratPrive\_signatoryX2   |
| signatoryY2    | ContratPrive\_signatoryY2   |

#### Un champ JSON multivalué regroupant les 4 paramètres

| Propriété JSON    | Champ par défaut                |
| ----------------- | ------------------------------- |
| signatoryPosition | ContratPrive\_signatoryPosition |

Par exemple :

```json
{"page":1, "x1":10, "y1":20, "x2":30, "y2":40 }
```

#### Un paramètre JSON global définissant l'ensemble des positions des signatures

| Propriété JSON | Champ par défaut |
| -------------- | ---------------- |
| signPositions  | *N/A*            |

Par exemple :

```json
"signPositions": [
    { "page": 1, "x1": 10, "y1": 20, "x2": 100, "y2": 100 },
    { "page": 1, "x1": 50, "y1": 20, "x2": 150, "y2": 120 }
]
```

### Notifications

| Propriété JSON | Description                                                                        | Champ par défaut            |
| -------------- | ---------------------------------------------------------------------------------- | --------------------------- |
| notifications  |                                                                                    | ContratPrive\_notifications |
| **message**    | Corps du message de notification à envoyer aux signataires.                        | ContratPrive\_message       |
| sendSms        | Si ce champ est `true` un SMS est envoyé aux signataires à la création du contrat. | ContratPrive\_sendSms       |

### Paramètres divers

Ces propriétés sont utilisées pour les connecteurs autres que la création de parapheur.

| Propriété JSON    | Description                                                                                                                        | Champ par défaut                |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| **contractId**    | La référence publique du contrat.                                                                                                  | ContratPrive\_contractId        |
| signatoryPublicId | La référence publique du signataire.                                                                                               | ContratPrive\_signatoryPublicId |
| signedDocuments   | Champ contenant les documents signés.                                                                                              | ContratPrive\_signedDocuments   |
| status            | Etat actuel du contrat. Les valeurs possibles sont `canceled`, `closed`, `deleted`, `draft`, `expired`, `submited` ou `suspended`. | ContratPrive\_status            |

### Exemple de JSON de configuration

```jsonc
{
    "title": "ContratPrive_title",
    "documents": "ContratPrive_documents",
    "appendices": "ContratPrive_appendices",
    "signedDocuments": "ContratPrive_signedDocuments",
    "signatureRequired": "ContratPrive_signatureRequired",
    "action": "ContratPrive_action",
    "language": "ContratPrive_language",
    "signPage": "ContratPrive_signPage",
    "signDueDate": "ContratPrive_signDueDate",
    "autoClosingDate": "ContratPrive_autoClosingDate",
    "type": "ContratPrive_type",
    "signatoryFirstname": "ContratPrive_signatoryFirstname",
    "signatoryLastname": "ContratPrive_signatoryLastname",
    "signatoryEmail": "ContratPrive_signatoryEmail",
    "signatoryPhone": "ContratPrive_signatoryPhone",
    "signatoryExternalId": "ContratPrive_signatoryExternalId",
    "signatoryPayment": "ContratPrive_signatoryPayment",
    "signatoryOrganization": "ContratPrive_signatoryOrganization",
    "signatoryPublicId": "ContratPrive_signatoryPublicId",
    "notifications": "ContratPrive_notifications",
    "message": "ContratPrive_message",
    "status": "ContratPrive_status",
    "contractId": "ContratPrive_contractId",
    "sendSms": "ContratPrive_sendSms",

    // Position de la signature: 3 possibilités

    // 4 champs multivalués pour chaque paramètre
    "signatoryPage": "ContratPrive_signatoryPage",
    "signatoryX1": "ContratPrive_signatoryX1",
    "signatoryY1": "ContratPrive_signatoryY1",
    "signatoryX2": "ContratPrive_signatoryX2",
    "signatoryY2": "ContratPrive_signatoryY2",

    // 1 champ JSON multivalué regroupant les 4 paramètres, par ex:
    // {"page":1, "x1":10, "y1":20, "x2":30, "y2":40 }
    "signatoryPosition": "ContratPrive_signatoryPosition",

    // 1 paramètre JSON global définissant l'ensemble des positions
    // des signatures
    "signPositions": [
        {
            "page": 1,
            "x1": 10,
            "y1": 20,
            "x2": 100,
            "y2": 100
        }
    ]
}
```

*NB* L'exemple ci-dessus comporte des commentaires et n'est pas un fichier JSON valide.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.efalia.com/produit/efalia-process/integrations/contrat-prive.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
