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 Assets. 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 Endpoints, Request-/Response-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 Endpoints, Parameter, Request-/Response-Body | API-Referenz (Swagger) |
| API Keys anlegen, verwalten & Best Practices | Organization → API Keys |
| Authentifizierungs-Konzept & Sicherheitshinweise | Authentication |
Grundprinzipien
- REST über HTTPS – JSON für Requests und Responses.
- Server – alle Aufrufe gehen gegen
https://my.digital-product-passport.cloud. - API-Key-Header – jeder Aufruf benötigt einen gültigen API Key im
x-api-key-Header. - API-First – die UI nutzt dieselben Endpoints 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 Key erstellen – siehe Organization → API Keys.
- Authentifizierung verstehen – siehe Authentication.
- Endpoints erkunden – direkt in der Swagger-Referenz inklusive „Try it out".