API
API REST
Conectar sus programas a cDESP con la clave X-API-KEY: sitios, exportación ZIP, modelos y documentos reglamentarios.
4 min de lectura
La API REST de cDESP permite a sus programas (ERP, GMAO, scripts) leer y crear sus sitios, exportar la carpeta de un sitio en ZIP y, según su suscripción, leer los modelos y los documentos reglamentarios. Responde en JSON.
Obtener su clave
- En el menú de la izquierda, haga clic en Ajustes.
- Baje hasta la tarjeta Token de API.
- Haga clic en Nuevo token.
- Haga clic en el icono Copiar token para copiarlo. El icono del ojo lo muestra en claro.
Consulte también Ajustes.
Llamar a la API
- Dirección base:
https://api.dcrr.fr/v1 - Envíe la clave en el encabezado
X-API-KEYde cada solicitud. - Para enviar datos (
POST), envíe JSON con el encabezadoContent-Type: application/json. - Usted ve los sitios que comparten al menos un grupo con su cuenta. Consulte Equipo y grupos.
- Límite: 500 solicitudes por minuto y por dirección IP.
- Referencia interactiva (Swagger): https://api.dcrr.fr/swagger/index.html
Primera prueba:
curl https://api.dcrr.fr/v1/sites \
-H "X-API-KEY: SU_CLAVE_API"
Lista de rutas
| Método | Ruta | Función | Acceso |
|---|---|---|---|
GET | /v1/sites | Listar sus sitios | cualquier clave válida |
GET | /v1/sites/{id} | Leer un sitio | cualquier clave válida |
GET | /v1/sites/{id}/export/zip | Descargar la carpeta del sitio en ZIP | cualquier clave válida |
POST | /v1/sites | Crear un sitio | según la suscripción |
DELETE | /v1/sites/{id} | Eliminar un sitio | según la suscripción |
GET | /v1/models | Listar los modelos | según la suscripción |
GET | /v1/models/{id} | Leer un modelo | según la suscripción |
GET | /v1/reglementary-documents | Listar los documentos reglamentarios | según la suscripción |
GET | /v1/reglementary-documents/{id} | Leer un documento reglamentario | según la suscripción |
{id} es el identificador del objeto, devuelto en el campo id.
Sitios
Listar y leer
GET /v1/sites devuelve todos sus sitios. GET /v1/sites/{id} devuelve un solo sitio.
curl https://api.dcrr.fr/v1/sites/507f1f77bcf86cd799439011 \
-H "X-API-KEY: SU_CLAVE_API"
{
"id": "507f1f77bcf86cd799439011",
"name": "Almacén Norte",
"code": "000042",
"address": "12 avenue des Lilas, 75000 Paris",
"group": ["Mi empresa"],
"files": [],
"order_index": 42,
"completed": false
}
Campos principales: name (nombre), code (código del sitio, asignado por cDESP), address (dirección), group (grupos que ven el sitio), files (enlaces de los archivos vinculados al sitio) y completed (true cuando el sitio está marcado como conforme en cDESP).
Crear un sitio
POST /v1/sites crea un sitio. Cuerpo JSON:
name(obligatorio): nombre del sitio.address(obligatorio): dirección.group(opcional): lista de grupos. Sin este campo, el sitio se vincula a todos sus grupos. Solo puede elegir grupos de los que forma parte.
curl -X POST https://api.dcrr.fr/v1/sites \
-H "X-API-KEY: SU_CLAVE_API" \
-H "Content-Type: application/json" \
-d '{"name": "Almacén Norte", "address": "12 avenue des Lilas, 75000 Paris"}'
Respuesta 201:
{ "message": "Site created successfully", "id": "507f1f77bcf86cd799439011" }
El código del sitio se asigna automáticamente. Algunas suscripciones limitan el número de sitios: por encima del límite, la respuesta es 403. La Licence Suivi no permite crear sitios.
Eliminar un sitio
DELETE /v1/sites/{id} elimina el sitio con sus sistemas y sus componentes. Esta acción es definitiva.
curl -X DELETE https://api.dcrr.fr/v1/sites/507f1f77bcf86cd799439011 \
-H "X-API-KEY: SU_CLAVE_API"
Exportar la carpeta en ZIP
GET /v1/sites/{id}/export/zip devuelve un archivo ZIP: documentos del sitio, informes de controles (plan de inspección, VI, IP, auditoría) con su versión firmada y fotos de los sistemas.
curl https://api.dcrr.fr/v1/sites/507f1f77bcf86cd799439011/export/zip \
-H "X-API-KEY: SU_CLAVE_API" \
-o site.zip
La API no genera la lista de equipos a presión sometidos (lista 6-III): en su lugar, el ZIP contiene un archivo vacío que lo indica. Genere esta lista desde cDESP. Consulte Carpeta del sitio.
Modelos
GET /v1/models devuelve el catálogo de modelos de equipos. GET /v1/models/{id} devuelve un modelo.
curl https://api.dcrr.fr/v1/models \
-H "X-API-KEY: SU_CLAVE_API"
Cada modelo contiene id, designation (designación), files (archivos asociados) y doc_files (documentación).
Documentos reglamentarios
GET /v1/reglementary-documents devuelve la lista de documentos reglamentarios. GET /v1/reglementary-documents/{id} devuelve un documento.
curl https://api.dcrr.fr/v1/reglementary-documents \
-H "X-API-KEY: SU_CLAVE_API"
Cada documento contiene id, name (nombre), file (enlace del archivo), created_at y updated_at.
Errores
| Código | Caso | Ejemplo de respuesta |
|---|---|---|
400 | Cuerpo de solicitud no válido, falta el nombre o la dirección | {"error": "Le nom et l'adresse sont obligatoires"} |
401 | Clave ausente o desconocida | {"message": "Invalid or missing API Key"} |
401 | Su suscripción no permite esta ruta | {"message": "You are not allowed to do this request"} |
403 | Sitio no compartido con sus grupos, o límite de la suscripción alcanzado | {"error": "You don't have access to this site"} |
429 | Más de 500 solicitudes en un minuto | {"message": "Too many requests, please slow down"} |
500 | Error del servidor, o sitio no encontrado al leerlo | {"error": "Failed to retrieve site: ..."} |
Los mensajes de error están en inglés o en francés. Compruebe el código HTTP en lugar del texto.