Resumen de la API¶
La API de DMS es una API JSON bajo /api/v1. La usan la interfaz web de DMS, los
clientes móviles y las integraciones.
Autenticación¶
| Cliente | Método |
|---|---|
| Navegador | Sesión del servidor con protección CSRF |
| Integración | Clave de API por usuario en Authorization: Bearer ldk_... o X-API-Key |
| Móvil | JWT Bearer de /api/v1/mobile/auth |
| Webhooks de BPM | Firma HMAC bajo /bpm |
Las solicitudes con clave de API no necesitan token CSRF. Siguen requiriendo TLS y una clave con los alcances correctos.
Convenciones¶
- Las solicitudes y respuestas usan JSON.
- Los endpoints de lista están paginados.
- Los errores devuelven una respuesta JSON estructurada con un código de estado HTTP.
- Las fechas y horas siguen los ajustes de zona horaria del espacio de trabajo y del usuario cuando el endpoint lo admite.
Grupos de endpoints¶
- documentos y archivos;
- Explorador y carpetas;
- búsqueda y búsquedas guardadas;
- usuarios, grupos, departamentos y roles;
- administración y configuración;
- integración con BPM, cargas y webhooks.
OpenAPI¶
Cuando está habilitado, el esquema OpenAPI está disponible en /openapi.json, con
Swagger en /docs y ReDoc en /redoc. Consulta OpenAPI.
Expón la API de forma deliberada
No expongas la API directamente a internet sin TLS y los controles de red que requiere tu organización. Usa claves de API con alcance limitado y rótalas.