API Übersicht
Einführung in die REST-API der Contsult DPP-Plattform – mit direktem Link zur interaktiven API-Referenz.
Die Contsult DPP-Plattform bietet eine REST-API für den programmatischen Zugriff auf Produktpässe, Attribute und Dateien. Die API folgt dem API-First-Prinzip – alle Funktionen, die über die Admin-Oberfläche verfügbar sind, können auch über die API gesteuert werden.
Vollständige API-Referenz
Die interaktive Swagger-Doku mit allen Endpunkten, Anfrage-/Antwort-Schemata und einer „Try it out"-Funktion findest du
unter my.digital-product-passport.cloud/api-docs.
Du musst dafür in der DPP-Plattform eingeloggt sein.
Was findest du wo?
| Inhalt | Ort |
|---|---|
| Alle Endpunkte, Parameter und Anfrage-/Antwort-Body | API-Referenz (Swagger) |
| API-Schlüssel anlegen und verwalten | Organization → API Keys |
| Authentifizierung und Sicherheitshinweise | Authentifizierung |
Grundprinzipien
- REST über HTTPS – JSON für Anfragen und Antworten.
- Server – alle Aufrufe gehen gegen
https://my.digital-product-passport.cloud. - API-Schlüssel-Header – jeder Aufruf benötigt einen gültigen API-Schlüssel im
x-api-key-Header. - API-First – die UI nutzt dieselben Endpunkte wie externe Integrationen.
Versionierung, Rate-Limit-Header und alle weiteren technischen Details sind in der Swagger-Doku dokumentiert und werden dort aktuell gehalten.
Erste Schritte
- API-Schlüssel erstellen – siehe Organization → API Keys.
- Authentifizierung verstehen – siehe Authentifizierung.
- Endpunkte erkunden – direkt in der Swagger-Referenz inklusive „Try it out".