Autorisierung
Callaba Engine verwendet ein API-Token, um geschützte Anfragen zu autorisieren. Generieren Sie das Token im Dashboard und senden Sie es mit jedem geschützten API-Aufruf.
Geeignet, wennEin vertrauenswürdiger Backend-Service muss geschützte Engine-Endpunkte aufrufen.
Anderes Modul verwenden, wennVerwenden Sie einen öffentlichen Viewer- oder Join-Endpunkt nur, wenn die jeweilige Methode ausdrücklich als öffentlich gekennzeichnet ist.
Voraussetzungen
- Melden Sie sich im Callaba-Dashboard an.
- Öffnen Sie Allgemeine Einstellungen und erzeugen Sie ein API-Token.
- Speichern Sie das Token in einem Secret Manager oder einer geschützten Umgebungsvariable.
- Senden Sie Anfragen an Ihre eigene Callaba Engine-Basis-URL über HTTPS.
Funktionen
Fügen Sie das Token als x-access-token-Request-Header hinzu:
curl --request POST \
--url https://YOUR_CALLABA_HOST/api/MODULE/METHOD \
--header 'content-type: application/json' \
--header 'x-access-token: YOUR_API_TOKEN' \
--data '{}'Verwenden Sie denselben Header für Listen-, Erstellungs-, Aktualisierungs-, Lebenszyklus- und Statistikmethoden, es sei denn, eine Methode ist explizit als öffentlich dokumentiert.
Beispiel-Workflow
- Laden Sie das Token nur in Ihrem Backend-Prozess.
- Rufen Sie eine Lesemethode mit dem Header auf, um die Basis-URL und das Token zu überprüfen.
- Behandeln Sie Autorisierungsfehler, bevor Sie Schreibvorgänge aktivieren.
- Rotieren Sie das Token, wenn es offengelegt wurde oder nicht mehr benötigt wird.
Typische Anwendungsfälle
- Autorisieren Sie ein Bedienfeld, das Live-Workflows startet und stoppt.
- Erlauben Sie einem Scheduler, Aufzeichnungen für gebuchte Ereignisse zu erstellen.
- Geben Sie einem Deployment-Worker Zugriff, damit er eine neue Engine-Instanz konfigurieren kann.
Einschränkungen und Fehlerbehebung
Geschützte Anfragen schlagen fehl, wenn das Token fehlt, ungültig oder widerrufen ist. Hinterlegen Sie das Token niemals in Browser-JavaScript, einem öffentlichen Repository, einer URL oder clientseitigen Logs. Öffentliche Viewer- und Join-Methoden haben eigene dokumentierte Zugriffsregeln; geschützte Lifecycle-Methoden werden dadurch nicht öffentlich.
Nächste Schritte
Überprüfen Sie die Autorisierung mit einer Lesemethode und öffnen Sie dann die Modulanleitung für die Ressource, die Sie verwalten möchten.