Zum Inhalt springen

Entwickeln mit Szenera

API, CLI, Apps-SDK und Webhooks von Szenera: Schlüssel erzeugen, Aufrufe absetzen, Ereignisse empfangen — und die Regeln, die auf jeder Route gelten.

Vollständig und maschinenlesbar

Die API-Referenz

Jede öffentliche Route mit ihren Feldern, Beispielen und Fehlern — erzeugt aus derselben Spezifikation, gegen die die Schnittstelle gebaut ist.

Referenz öffnen

Spezifikation als Datei

Was es gibt

  • API. Die HTTP-API unter /v1 ist die Grundlage von allem: OpenAPI 3.1, 19 Tags in sieben Gruppen, die Referenz unter /api/reference und die Spezifikation unter /api/openapi.json. Daneben stehen die Wege, die ein fremder Standard vorgibt: der delegierte Zugang über OAuth 2.1 und die Provisionierung über SCIM.
  • CLI. Die Kommandozeile szenera bündelt 136 Befehle für Organisationen mit JSON-Ausgabe und Exit-Codes; jeder Befehl ist ein API-Aufruf, und einen öffentlichen Bezugsweg gibt es heute nicht — wer den Quellbaum der Plattform hat, baut sie daraus.
  • Apps-SDK. Das SDK legt fest, wie eine App gebaut ist — Manifest, Widget, Server-Teil, Signatur — und wie sie in den Katalog kommt; es ist heute nicht veröffentlicht, die Seiten beschreiben den Vertrag, wie er im Quellbaum der Plattform gilt.
  • Webhooks. Webhooks tragen Ereignisse Ihrer Organisation an Ihre Systeme: Endpunkt anlegen, HMAC-Signatur prüfen, Wiederholungen verstehen, den Ereigniskatalog abrufen.
  • Änderungen. Was an der API stabil ist, wo Änderungen erscheinen und wie Sie die Spezifikation gegen Ihren Stand vergleichen.

tl;dr in fünf Befehlen

szenera health --profile=staging                               # Antwortet die Umgebung? Fragt /health/ready, ganz ohne Ausweis
szenera whoami --json                                          # Konto, Organisation und Rechte des Ausweises; eine 401 heißt: der Schlüssel gilt nicht
szenera playlist list --json | jq -r '.items[].id'             # Die Wiedergabelisten als JSON; Listen tragen items und, solange Seiten folgen, nextCursor
szenera asset upload --file=plakat.png                         # Prüfsumme rechnen, Bytes schieben, auf „ready" warten — ein Vorgang; Exit 11 und 12 trennen rot von unbekannt
szenera player set-program ply_01K… --content=scene:scn_01K…   # Einem Display etwas zuweisen — idempotent, dieselbe Zuweisung zweimal ist kein zweiter Vorgang

Die CLI wird heute nicht als eigenständiges Paket ausgeliefert; wie Sie sie aus dem Quellbaum bauen, steht unter Die CLI beziehen. Jeder Befehl ist ein API-Aufruf, den die Seite Der erste Aufruf mit curl auch mit curl zeigt.

Anfangen 1 Bereich

Schnittstellen 3 Bereiche

Erweitern 1 Bereich

Verfolgen 1 Bereich