API
REST-API
Ihre Programme mit dem Schlüssel X-API-KEY an cDESP anbinden: Standorte, ZIP-Export, Modelle und regulatorische Dokumente.
4 Min. Lesezeit
Mit der REST-API von cDESP können Ihre Programme (ERP, CMMS, Skripte) Ihre Standorte abrufen und anlegen, den Ordner eines Standorts als ZIP exportieren und je nach Abonnement Modelle und regulatorische Dokumente abrufen. Die API antwortet in JSON.
Ihren Schlüssel erhalten
- Klicken Sie im linken Menü auf Einstellungen.
- Scrollen Sie bis zur Karte API-Token.
- Klicken Sie auf Neues Token.
- Klicken Sie auf das Symbol Token kopieren, um es zu kopieren. Das Augensymbol zeigt es im Klartext an.
Siehe auch Einstellungen.
Die API aufrufen
- Basisadresse:
https://api.dcrr.fr/v1 - Senden Sie den Schlüssel bei jeder Anfrage im Header
X-API-KEY. - Beim Senden von Daten (
POST) schicken Sie JSON mit dem HeaderContent-Type: application/json. - Sie sehen die Standorte, die mindestens eine Gruppe mit Ihrem Konto teilen. Siehe Team und Gruppen.
- Grenze: 500 Anfragen pro Minute und IP-Adresse.
- Interaktive Referenz (Swagger): https://api.dcrr.fr/swagger/index.html
Erster Test:
curl https://api.dcrr.fr/v1/sites \
-H "X-API-KEY: IHR_API_SCHLUESSEL"
Liste der Routen
| Methode | Pfad | Zweck | Zugriff |
|---|---|---|---|
GET | /v1/sites | Ihre Standorte auflisten | jeder gültige Schlüssel |
GET | /v1/sites/{id} | Einen Standort abrufen | jeder gültige Schlüssel |
GET | /v1/sites/{id}/export/zip | Den Standortordner als ZIP herunterladen | jeder gültige Schlüssel |
POST | /v1/sites | Einen Standort anlegen | je nach Abonnement |
DELETE | /v1/sites/{id} | Einen Standort löschen | je nach Abonnement |
GET | /v1/models | Modelle auflisten | je nach Abonnement |
GET | /v1/models/{id} | Ein Modell abrufen | je nach Abonnement |
GET | /v1/reglementary-documents | Regulatorische Dokumente auflisten | je nach Abonnement |
GET | /v1/reglementary-documents/{id} | Ein regulatorisches Dokument abrufen | je nach Abonnement |
{id} ist die Kennung des Objekts, die im Feld id zurückgegeben wird.
Standorte
Auflisten und abrufen
GET /v1/sites liefert alle Ihre Standorte. GET /v1/sites/{id} liefert einen einzelnen Standort.
curl https://api.dcrr.fr/v1/sites/507f1f77bcf86cd799439011 \
-H "X-API-KEY: IHR_API_SCHLUESSEL"
{
"id": "507f1f77bcf86cd799439011",
"name": "Entrepôt Nord",
"code": "000042",
"address": "12 avenue des Lilas, 75000 Paris",
"group": ["Mon entreprise"],
"files": [],
"order_index": 42,
"completed": false
}
Wichtigste Felder: name (Name), code (Standortcode, von cDESP vergeben), address, group (Gruppen, die den Standort sehen), files (Links der dem Standort zugeordneten Dateien) und completed (true, wenn der Standort in cDESP als konform markiert ist).
Einen Standort anlegen
POST /v1/sites legt einen Standort an. JSON-Inhalt:
name(Pflichtfeld): Name des Standorts.address(Pflichtfeld): Adresse.group(optional): Liste von Gruppen. Ohne dieses Feld wird der Standort allen Ihren Gruppen zugeordnet. Sie können nur Gruppen wählen, denen Sie angehören.
curl -X POST https://api.dcrr.fr/v1/sites \
-H "X-API-KEY: IHR_API_SCHLUESSEL" \
-H "Content-Type: application/json" \
-d '{"name": "Entrepôt Nord", "address": "12 avenue des Lilas, 75000 Paris"}'
Antwort 201:
{ "message": "Site created successfully", "id": "507f1f77bcf86cd799439011" }
Der Standortcode wird automatisch vergeben. Manche Abonnements begrenzen die Zahl der Standorte: Darüber hinaus lautet die Antwort 403. Mit der Licence Suivi können keine Standorte angelegt werden.
Einen Standort löschen
DELETE /v1/sites/{id} löscht den Standort mit seinen Systemen und deren Komponenten. Diese Aktion ist endgültig.
curl -X DELETE https://api.dcrr.fr/v1/sites/507f1f77bcf86cd799439011 \
-H "X-API-KEY: IHR_API_SCHLUESSEL"
Den Ordner als ZIP exportieren
GET /v1/sites/{id}/export/zip liefert eine ZIP-Datei: Dokumente des Standorts, Prüfberichte (Inspektionsplan, VI, IP, Audit) mit ihrer unterschriebenen Fassung und Fotos der Systeme.
curl https://api.dcrr.fr/v1/sites/507f1f77bcf86cd799439011/export/zip \
-H "X-API-KEY: IHR_API_SCHLUESSEL" \
-o site.zip
Die Liste der überwachungspflichtigen Druckgeräte (Liste 6-III) wird nicht von der API erzeugt: Die ZIP-Datei enthält stattdessen eine leere Datei, die darauf hinweist. Erstellen Sie diese Liste in cDESP. Siehe Standortordner.
Modelle
GET /v1/models liefert den Katalog der Gerätemodelle. GET /v1/models/{id} liefert ein Modell.
curl https://api.dcrr.fr/v1/models \
-H "X-API-KEY: IHR_API_SCHLUESSEL"
Jedes Modell enthält id, designation (Bezeichnung), files (zugehörige Dateien) und doc_files (Dokumentation).
Regulatorische Dokumente
GET /v1/reglementary-documents liefert die Liste der regulatorischen Dokumente. GET /v1/reglementary-documents/{id} liefert ein Dokument.
curl https://api.dcrr.fr/v1/reglementary-documents \
-H "X-API-KEY: IHR_API_SCHLUESSEL"
Jedes Dokument enthält id, name (Name), file (Link der Datei), created_at und updated_at.
Fehler
| Code | Fall | Beispielantwort |
|---|---|---|
400 | Ungültiger Anfrageinhalt, Name oder Adresse fehlt | {"error": "Le nom et l'adresse sont obligatoires"} |
401 | Schlüssel fehlt oder ist unbekannt | {"message": "Invalid or missing API Key"} |
401 | Ihr Abonnement erlaubt diese Route nicht | {"message": "You are not allowed to do this request"} |
403 | Standort nicht mit Ihren Gruppen geteilt oder Grenze des Abonnements erreicht | {"error": "You don't have access to this site"} |
429 | Mehr als 500 Anfragen in einer Minute | {"message": "Too many requests, please slow down"} |
500 | Serverfehler oder Standort beim Abrufen nicht gefunden | {"error": "Failed to retrieve site: ..."} |
Die Fehlermeldungen sind auf Englisch oder Französisch. Werten Sie den HTTP-Code aus, nicht den Text.