L'API REST
EntityFlow expose une surface REST publique fine et versionnée, montée sur /api/v1. Elle applique les mêmes vérifications de permissions à portée de locataire que l'application : tout ce que vous ne pouvez pas faire dans l'interface, vous ne pouvez pas le faire via l'API.
Authentification
Envoyez un en-tête Authorization: Bearer <token>. Le jeton est soit :
- un jeton de session, soit
- une clé d'API (
ef_live_...) — voir Clés d'API.
curl https://<your-host>/api/v1/diagrams \
-H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"
Points de terminaison
| Méthode et chemin | Objectif |
|---|---|
GET /api/v1/diagrams | Lister les diagrammes. |
POST /api/v1/diagrams | Créer un diagramme. |
GET /api/v1/diagrams/{id} | Récupérer un diagramme unique. |
PUT /api/v1/diagrams/{id} | Enregistrer (mettre à jour) un diagramme. |
DELETE /api/v1/diagrams/{id} | Supprimer un diagramme. |
POST /api/v1/diagrams/{id}/export | Exporter du SQL ou du DBML. |
GET /api/v1/catalog/tables | Rechercher des tables dans l'ensemble des diagrammes. |
/api/v1/keys | Gérer les clés d'API. |
/api/v1/webhooks | Gérer les webhooks. |
OpenAPI et documentation interactive
| Ressource | URL |
|---|---|
| Spécification OpenAPI | /api/v1/openapi.json |
| Documentation interactive | /api/v1/docs |
Utilisez le document OpenAPI pour générer des clients dans le langage de votre choix, et la documentation interactive pour explorer les requêtes en direct.
remarque
La surface REST est versionnée indépendamment. Une incrémentation de version majeure (par exemple, /api/v2) signale des changements cassants ; au sein d'une version majeure, les changements sont additifs et rétrocompatibles.