> 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/ressources-developpeurs.md).

# Ressources Développeurs

Références, outils et liens utiles pour développer avec Efalia Process.

***

## Documentation Interne

| Ressource                                                                                                          | Description                                  |
| ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- |
| [Vue d'Ensemble API](/documentations/efalia-process/vue-ensemble-api.md)                                           | Point de départ pour les développeurs        |
| [Documentation API REST](/documentations/efalia-process/vue-ensemble-api/documentation-api-rest.md)                | Référence des endpoints                      |
| [Connecteur API REST](/documentations/efalia-process/vue-ensemble-api/connecteur-api-rest.md)                      | Appeler des services externes depuis Process |
| [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              |
| [Syntaxes JSON/JSONPath](/documentations/efalia-process/vue-ensemble-api/syntaxes-json-jsonpath.md)                | Formats de données                           |
| [Webhooks et Événements](/documentations/efalia-process/vue-ensemble-api/webhooks-evenements.md)                   | Notifications temps réel                     |
| [Développer un Connecteur Custom](/documentations/efalia-process/vue-ensemble-api/developper-connecteur-custom.md) | Connecteurs Java sur mesure                  |
| [SDKs et Bibliothèques](/documentations/efalia-process/vue-ensemble-api/sdks-bibliotheques.md)                     | Clients et outils                            |

***

## API Swagger UI

La documentation interactive de l'API est accessible sur votre instance :

```
https://<votre-serveur>/workey/swagger-ui.html
```

La spécification OpenAPI (pour import dans Postman/Insomnia) :

```
https://<votre-serveur>/workey/api-docs
```

***

## Environnements de Test

{% hint style="warning" %}
**Ne jamais développer directement en production**

Utilisez toujours un environnement de **développement** ou de **recette** pour vos tests. Les erreurs de connecteur ou d'API peuvent créer des documents parasites ou déclencher des notifications non souhaitées.
{% endhint %}

### Checklist Environnement de Dev

* [ ] Instance Efalia Process dédiée (non production)
* [ ] Compte de service de test avec droits limités
* [ ] Processus de test modélisés avec des données fictives
* [ ] Logs activés (`catalina.out` accessible)
* [ ] Accès à la console d'administration

***

## Outils Recommandés

### Test d'API REST

| Outil        | Usage                                        | Lien               |
| ------------ | -------------------------------------------- | ------------------ |
| **Postman**  | Test interactif, collections, environnements | postman.com        |
| **Insomnia** | Alternative à Postman, léger                 | insomnia.rest      |
| **curl**     | Ligne de commande, scripts                   | Inclus Linux/macOS |
| **HTTPie**   | curl plus lisible                            | httpie.io          |

### Validation JSON/JSONPath

| Outil                      | Usage                           |
| -------------------------- | ------------------------------- |
| `jsonlint.com`             | Valider la syntaxe d'un JSON    |
| `jsonpath.com`             | Tester des expressions JSONPath |
| Extension VS Code **JSON** | Coloration + validation inline  |

### Développement de Connecteurs Java

| Outil                            | Description                                 |
| -------------------------------- | ------------------------------------------- |
| **IntelliJ IDEA** ou **Eclipse** | IDE Java recommandé                         |
| **Maven** ou **Gradle**          | Gestion de dépendances                      |
| **JDK 1.8.x**                    | Version Java compatible avec Efalia Process |

***

## Groovy — Connecteur Script

Le `ScriptConnector` et le callback `callbackScript` du connecteur ApiRest utilisent **Groovy**. Groovy est un langage de script compatible Java — tout code Java est valide en Groovy.

**Ressources Groovy :**

* Documentation officielle : `groovy-lang.org`
* Groovy est préinstallé avec Efalia Process — pas d'installation requise
* Les scripts `.groovy` se placent dans `$WORKEY_DATA/scripts/`

***

## Structure de Référence

### URLs d'Accès aux Applications Process

| Application                 | URL                                       |
| --------------------------- | ----------------------------------------- |
| Application principale      | `$CONTEXT_PROCESS/workey`                 |
| Console d'administration    | `$CONTEXT_PROCESS/workey/admin`           |
| API REST                    | `$CONTEXT_PROCESS/workey/api`             |
| Swagger UI                  | `$CONTEXT_PROCESS/workey/swagger-ui.html` |
| Spec OpenAPI                | `$CONTEXT_PROCESS/workey/api-docs`        |
| Espace publication statique | `$CONTEXT_PROCESS/publish/public/*`       |
| Endpoint webhooks           | `$CONTEXT_PROCESS/workey/webhook/*`       |

### Répertoires Serveur Importants

| Répertoire                                | Contenu                                        |
| ----------------------------------------- | ---------------------------------------------- |
| `$CATALINA_HOME/conf/catalina.properties` | Configuration principale                       |
| `$CATALINA_HOME/logs/catalina.out`        | Journaux principaux                            |
| `$WORKEY_DATA/scripts/`                   | Scripts Groovy pour ScriptConnector et ApiRest |
| `$WORKEY_DATA/velocity-templates/mail/`   | Templates email Velocity                       |
| `$CATALINA_HOME/lib/`                     | JARs des connecteurs custom                    |

***

## Support et Communauté

* **Documentation officielle** : docs.efalia.com
* **Support Efalia** : Contactez votre interlocuteur Efalia habituel pour les questions d'intégration complexes

***

Pour aller plus loin :

* [Vue d'Ensemble des Intégrations](/documentations/efalia-process/vue-ensemble.md)
* [Administration Technique](/documentations/efalia-process/administration/administration-technique/preconisations-materielles.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/ressources-developpeurs.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.