Skip to Content
API-ReferenzAuthentifizierung

Authentifizierung

API-Key erhalten

Du kannst einen API-Key auf der Seite API Integrations  in der Ignite-Admin-Oberfläche erstellen. Du brauchst die Rolle admin, um auf diese Seite zuzugreifen.

Wenn du einen Key erstellst, wählst du seine Berechtigungen und optional einen Kategorie-Scope.

Berechtigungen

API-Key-Berechtigungen werden pro Ressource vergeben. Aktiviere nur die Aktionen, die deine Integration braucht.

RessourceVerfügbare Aktionen
Videosread, create, update, delete, publish
Live-Eventsread, create, update, delete, publish
Tagscreate, update, delete
Kategoriencreate, update, delete
Analyticsread

Lesezugriff auf Kategorien, Tags und Player-Presets ist immer gewährt. Du musst ihn nicht aktivieren. API-Keys können keine Player-Presets erstellen, aktualisieren oder löschen.

publish ist getrennt von create und update. visibility: public wird nur gespeichert, wenn der Key videos.publish hat. Ohne diese Berechtigung speichert das Erstellen private. Ein PATCH, der visibility setzt, wird akzeptiert, das Feld bleibt unverändert, und die Antwort bleibt 200. Keiner der beiden Fälle liefert 403.

Analytics-Endpoints erfordern analytics.read. Video-read allein reicht nicht. Siehe Analytics.

API-Keys können keine Mitglieder, Webhooks, andere API-Integrationen oder Account-Einstellungen verwalten.

Kategorie-Scope

Du kannst einen API-Key auf eine oder mehrere Kategorien beschränken. Der Scope umfasst diese Kategorien und ihre Unterkategorien. Er filtert Lese- und Schreibzugriffe auf Videos sowie Lese-, Aktualisierungs- und Löschzugriffe auf Kategorien. Ein Key mit Scope kann keine Kategorie löschen, die einer seiner Scope-Anker ist. Wenn du ein Video erstellst und keine Kategorien sendest, werden die Scope-Kategorien zugewiesen, bis zu 10. Lässt du das Feld leer, kann der Key auf jede Kategorie im Workspace zugreifen.

Der Kategorie-Scope beschränkt keine Tags und keine Live-Events. Er gilt für Analytics-Aufrufe pro Video.

API-Key verwenden

Übergib deinen API-Key als Bearer-Token im Authorization-Header deiner Anfrage.

curl -X GET https://app.ignitevideo.cloud/api/videos \ -H "Authorization: Bearer YOUR_API_KEY"

Fehlender oder ungültiger API-Key

Ein fehlender oder ungültiger API-Key liefert 403:

{ "errors": [ { "message": "You are not allowed to perform this action" } ] }

Formen der Fehlerantworten

Collection-Endpoints (Videos, Kategorien, Tags und Player-Presets) liefern Payload-Fehler als { errors: [{ message }] }.

Custom-Endpoints (Upload, Ersetzen, Thumbnails, Text tracks, Multipart Upload und KI-Routen) liefern { error, message? }. Bei manchen Fehlern fehlt message. Ein Berechtigungsfehler auf diesen Routen liefert 403.

{ "error": "not_found" }
{ "error": "invalid_video_id" }

Ein Feld, das die Validierung an einem Collection-Endpoint nicht besteht, liefert 400 mit der Payload-Fehlerform.

Ein GET auf ein fehlendes Video, eine fehlende Kategorie oder einen fehlenden Tag liefert 404 { errors: [{ message: "Not Found" }] }. PATCH oder DELETE einer fehlenden Id liefert 403 mit dem Payload-Fehler oben. Die Antwort ist dieselbe, wenn das Dokument fehlt und wenn der Key es nicht sehen darf.