Zum Hauptinhalt springen

​
Öffentliche Hybridbox-API

​
Authentifizierung

Die REST-API verwendet OAuth-2.0-Bearer-Access-Tokens. So erhalten Browser- oder Web-App-Integrationen ein Token:
  1. Starten Sie den standardmäßigen OAuth-Authorization-Code-Flow mit dem öffentlichen Client der Hybridbox-Web-App.
  2. Leiten Sie den Benutzer zum Hybridbox-Autorisierungsendpunkt weiter und fordern Sie die üblichen OpenID-Scopes an.
  3. Nachdem der Benutzer angemeldet ist, tauschen Sie den zurückgegebenen Autorisierungscode am Hybridbox-Token-Endpunkt gegen Tokens aus. Öffentliche Browser-Clients sollten PKCE verwenden; serverseitige Web-Apps sollten den Code-Austausch im Backend ausführen.
  4. Lesen Sie access_token aus der Token-Antwort.
Verwenden Sie das Access Token für authentifizierte REST-API-Anfragen: 
Authorization: Bearer <access_token>
Die API validiert den Token-Aussteller und verlangt eine erlaubte öffentliche Client-ID, einschließlich des Hybridbox-Web-App-Clients. Endpoint-Seiten listen zusätzliche erforderliche Berechtigungen für den authentifizierten Benutzer oder die Gruppe auf.

​
OpenAPI-Spezifikation

Laden Sie den vollständigen Vertrag der öffentlichen API als openapi.json herunter.