> 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/documentations/efalia-process/vue-ensemble-api.md).

# Développeurs

Cette section s'adresse aux développeurs et intégrateurs souhaitant interagir avec Efalia Process de façon programmatique : appeler son API REST, développer des connecteurs Java, utiliser les langages embarqués (STalk, WKYJS), ou intégrer Efalia Process dans un système d'information.

***

## Ce que vous pouvez faire avec l'API Efalia Process

Efalia Process expose une **API REST complète** permettant à tout système externe de :

| Action                        | Description                                                |
| ----------------------------- | ---------------------------------------------------------- |
| **Créer des documents**       | Instancier un nouveau document dans un processus           |
| **Déclencher des opérations** | Faire avancer un workflow par programme                    |
| **Lire les données**          | Récupérer les champs d'un formulaire, l'état d'un document |
| **Rechercher**                | Filtrer des documents selon des critères métier            |
| **Gérer les utilisateurs**    | Créer, modifier, interroger des comptes utilisateurs       |
| **Piloter les rôles**         | Attribuer ou retirer des rôles dynamiquement               |
| **Écouter les événements**    | Recevoir des notifications via webhooks                    |

***

## Les Ressources Disponibles

### Pour interagir avec Process depuis l'extérieur

| Ressource                                                                                           | Description                                  |
| --------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| [Documentation API REST](/documentations/efalia-process/vue-ensemble-api/documentation-api-rest.md) | Référence complète des endpoints disponibles |
| [Webhooks et Événements](/documentations/efalia-process/vue-ensemble-api/webhooks-evenements.md)    | Recevoir des notifications en temps réel     |
| [SDKs et Bibliothèques](/documentations/efalia-process/vue-ensemble-api/sdks-bibliotheques.md)      | Clients et outils disponibles                |

### Pour étendre Process de l'intérieur

| Ressource                                                                                                          | Description                                      |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ |
| [Connecteur API REST](/documentations/efalia-process/vue-ensemble-api/connecteur-api-rest.md)                      | Appeler des services externes depuis un workflow |
| [Développer un Connecteur Custom](/documentations/efalia-process/vue-ensemble-api/developper-connecteur-custom.md) | Créer des connecteurs Java sur mesure            |
| [Référence STalk](/documentations/efalia-process/vue-ensemble-api/reference-stalk.md)                              | Langage d'expression côté serveur                |
| [Référence WKYJS](/documentations/efalia-process/vue-ensemble-api/reference-wkyjs.md)                              | Bibliothèque JavaScript côté client              |
| [JavaScript dans Process](/documentations/efalia-process/vue-ensemble-api/javascript-process.md)                   | Scripts JS dans les formulaires                  |

### Référence technique

| Ressource                                                                                             | Description                             |
| ----------------------------------------------------------------------------------------------------- | --------------------------------------- |
| [Syntaxes JSON/JSONPath](/documentations/efalia-process/vue-ensemble-api/syntaxes-json-jsonpath.md)   | Format JSON et requêtes JSONPath        |
| [Ressources Développeurs](/documentations/efalia-process/vue-ensemble-api/ressources-developpeurs.md) | Liens, outils et environnements de test |

***

## Architecture d'Intégration

```
Système externe
      │
      ├─ Appel API REST ──────────────► Efalia Process API
      │                                        │
      └─ Réception webhook ◄──────────── Événements Process
                                               │
                                    ┌──────────┴──────────┐
                                    │                     │
                               Connecteurs            WKYJS / STalk
                               Java (serveur)         (formulaires)
                                    │
                               Services externes
                               (GED, ERP, CRM...)
```

***

## Authentification à l'API

L'API REST Efalia Process utilise une authentification **HTTP Basic** (login + mot de passe) ou un **token de session** JWT.

```bash
# Authentification Basic
curl -u login:password https://process.example.com/workey/api/documents

# Avec token
curl -H "Authorization: Bearer <token>" https://process.example.com/workey/api/documents
```

{% hint style="warning" %}
**Compte de service**

Pour les intégrations automatisées, utilisez un compte de service dédié avec les droits strictement nécessaires. Évitez d'utiliser un compte utilisateur nominatif.
{% endhint %}

***

## Format des Données

L'API REST Efalia Process échange des données au format **JSON**. Pour une introduction à JSON et JSONPath (utilisé pour interroger les réponses), consultez [Syntaxes JSON/JSONPath](/documentations/efalia-process/vue-ensemble-api/syntaxes-json-jsonpath.md).

***

## Environnement de Développement

Pour tester l'API sans impacter la production :

* Utilisez un environnement de **recette** dédié
* L'interface **Swagger UI** est accessible à `/workey/swagger-ui.html` sur votre instance

Pour aller plus loin :

* [Documentation API REST](/documentations/efalia-process/vue-ensemble-api/documentation-api-rest.md)
* [Ressources Développeurs](/documentations/efalia-process/vue-ensemble-api/ressources-developpeurs.md)


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.efalia.com/documentations/efalia-process/vue-ensemble-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.