La API REST
EntityFlow expone una superficie REST pública, ligera y versionada, montada en /api/v1. Aplica las mismas comprobaciones de permisos con alcance de inquilino que la aplicación, de modo que cualquier cosa que no puedas hacer en la interfaz tampoco podrás hacerla a través de la API.
Autenticación
Envía un encabezado Authorization: Bearer <token>. El token es:
- un token de sesión, o
- una clave de API (
ef_live_...) — consulta Claves de API.
curl https://<your-host>/api/v1/diagrams \
-H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"
Endpoints
| Método y ruta | Propósito |
|---|---|
GET /api/v1/diagrams | Listar diagramas. |
POST /api/v1/diagrams | Crear un diagrama. |
GET /api/v1/diagrams/{id} | Obtener un único diagrama. |
PUT /api/v1/diagrams/{id} | Guardar (actualizar) un diagrama. |
DELETE /api/v1/diagrams/{id} | Eliminar un diagrama. |
POST /api/v1/diagrams/{id}/export | Exportar SQL o DBML. |
GET /api/v1/catalog/tables | Buscar tablas en todos los diagramas. |
/api/v1/keys | Gestionar claves de API. |
/api/v1/webhooks | Gestionar webhooks. |
OpenAPI y documentación interactiva
| Recurso | URL |
|---|---|
| Especificación OpenAPI | /api/v1/openapi.json |
| Documentación interactiva | /api/v1/docs |
Usa el documento OpenAPI para generar clientes en el lenguaje que prefieras, y la documentación interactiva para explorar las peticiones en vivo.
nota
La superficie REST está versionada de forma independiente. Un incremento de versión mayor (por ejemplo, /api/v2) señala cambios incompatibles; dentro de una versión mayor, los cambios son aditivos y retrocompatibles.