Developer / Digital Relax
Digital Relax API – Project API v1
Die offizielle Project API verbindet eigenständige Kundenanwendungen mit der zentralen Digital Relax Plattform. Der Zugang ist projektgebunden und authentifiziert. Eine allgemeine, frei zugängliche Sandbox oder öffentliche Self-Service-Schlüsselerstellung wird derzeit nicht zugesagt.
Basisadresse und Transport
Basis: https://www.digital-relax.de/api/v1/projects/:projectId. Die öffentliche API verwendet HTTPS und strukturierte JSON-Anfragen. Welche Aktionen zulässig sind, hängt von den Berechtigungen des konkreten Projekts ab. Ein Token eines Projekts darf nicht für ein anderes Projekt verwendet werden.
Dokumentierte Ressourcen
- GET/POST /consents: versionierte Einwilligungsnachweise.
- GET/POST /submissions: strukturierte Einreichungen.
- GET/POST /data: projektgebundene strukturierte Daten.
- GET/POST /events: Aktivitäts- und Ereignistransport.
- GET /consent-documents/:documentId: Metadaten zu Einwilligungsdokumenten.
Weitere Funktionen können lokal vorbereitet sein, ohne produktiv freigegeben zu sein. Diese Liste ist keine Zusicherung allgemeiner öffentlicher Zugriffsrechte auf alle Routen.
Authentifizierung und sichere Nutzung
Der Projektserver verwendet ein projektgebundenes Bearer-Token mit der jeweils erforderlichen Capability. Schreibaufrufe benötigen einen stabilen Idempotency-Key. Soweit für das Projekt konfiguriert, wird außerdem die zugelassene Origin geprüft; für Server-Integrationen ist X-DR-Project-Origin vorgesehen. Zugangsdaten gehören ausschließlich auf vertrauenswürdige Server und nicht in Browsercode, öffentliche Repositories oder Prompts eines Agenten.
Onboarding
Bevor ein Agent oder eine Anwendung die API nutzt, muss ein berechtigter Betreiber das Projekt, die zulässigen Aktionen und die sichere Übergabe der Zugangsdaten konfigurieren. Ohne freigegebene Berechtigung sollten keine Schreiboperationen oder automatisierte Kundendatenübermittlungen versucht werden. Aktuelle öffentliche Serviceangebote und Kontaktwege stehen auf der Website bereit.