L'API REST
EntityFlow espone una superficie REST pubblica, leggera e versionata, montata su /api/v1. Applica le stesse verifiche dei permessi con ambito tenant dell'applicazione, quindi tutto ciò che non puoi fare nell'interfaccia non puoi farlo tramite l'API.
Autenticazione
Invia un'intestazione Authorization: Bearer <token>. Il token è:
- un token di sessione, oppure
- una chiave API (
ef_live_...) — vedi Chiavi API.
curl https://<your-host>/api/v1/diagrams \
-H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"
Endpoint
| Metodo e percorso | Scopo |
|---|---|
GET /api/v1/diagrams | Elenca i diagrammi. |
POST /api/v1/diagrams | Crea un diagramma. |
GET /api/v1/diagrams/{id} | Recupera un singolo diagramma. |
PUT /api/v1/diagrams/{id} | Salva (aggiorna) un diagramma. |
DELETE /api/v1/diagrams/{id} | Elimina un diagramma. |
POST /api/v1/diagrams/{id}/export | Esporta SQL o DBML. |
GET /api/v1/catalog/tables | Cerca tabelle in tutti i diagrammi. |
/api/v1/keys | Gestisci le chiavi API. |
/api/v1/webhooks | Gestisci i webhook. |
OpenAPI e documentazione interattiva
| Risorsa | URL |
|---|---|
| Specifica OpenAPI | /api/v1/openapi.json |
| Documentazione interattiva | /api/v1/docs |
Usa il documento OpenAPI per generare client nel linguaggio che preferisci e la documentazione interattiva per esplorare le richieste in tempo reale.
note
La superficie REST è versionata in modo indipendente. Un incremento di versione maggiore (per esempio, /api/v2) segnala modifiche che introducono incompatibilità; all'interno di una versione maggiore, le modifiche sono additive e retrocompatibili.