Die REST-API
EntityFlow stellt eine schlanke, versionierte öffentliche REST-Oberfläche bereit, die unter /api/v1 eingebunden ist. Sie wendet dieselben mandantenbezogenen Berechtigungsprüfungen wie die Anwendung an, sodass alles, was Sie in der Benutzeroberfläche nicht tun können, auch über die API nicht möglich ist.
Authentifizierung
Senden Sie einen Authorization: Bearer <token>-Header. Das Token ist entweder:
- ein Sitzungstoken oder
- ein API-Schlüssel (
ef_live_...) — siehe API-Schlüssel.
curl https://<your-host>/api/v1/diagrams \
-H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"
Endpunkte
| Methode & Pfad | Zweck |
|---|---|
GET /api/v1/diagrams | Diagramme auflisten. |
POST /api/v1/diagrams | Ein Diagramm erstellen. |
GET /api/v1/diagrams/{id} | Ein einzelnes Diagramm abrufen. |
PUT /api/v1/diagrams/{id} | Ein Diagramm speichern (aktualisieren). |
DELETE /api/v1/diagrams/{id} | Ein Diagramm löschen. |
POST /api/v1/diagrams/{id}/export | SQL oder DBML exportieren. |
GET /api/v1/catalog/tables | Tabellen über alle Diagramme hinweg durchsuchen. |
/api/v1/keys | API-Schlüssel verwalten. |
/api/v1/webhooks | Webhooks verwalten. |
OpenAPI & interaktive Dokumentation
| Ressource | URL |
|---|---|
| OpenAPI-Spezifikation | /api/v1/openapi.json |
| Interaktive Dokumentation | /api/v1/docs |
Verwenden Sie das OpenAPI-Dokument, um Clients in der Sprache Ihrer Wahl zu generieren, und die interaktive Dokumentation, um Anfragen live zu erkunden.
Die REST-Oberfläche wird unabhängig versioniert. Eine Erhöhung der Hauptversion (zum Beispiel /api/v2) signalisiert nicht abwärtskompatible Änderungen; innerhalb einer Hauptversion sind Änderungen additiv und abwärtskompatibel.