Die richtige API-Version wählen

Die aktuelle App nutzt die API /app/api/v1. Ältere Integrationen können den separaten Dienst api.screenapp.io/v2 verwenden. Endpunkte, Zugangsdaten und Upload-Abläufe sind nicht austauschbar.

Bevor Sie eine bestehende Integration ändern, ermitteln Sie ihre Basis-URL und die Kontogeneration. Für eine Legacy-Integration lesen Sie die v2-Referenz und klären mit ScreenApp, ob eine Migration unterstützt wird.

Einen Schlüssel für die aktuelle App erstellen

Öffnen Sie Einstellungen > API in der aktuellen App. Erstellen Sie einen benannten Schlüssel mit den engsten nötigen Scopes und speichern Sie ihn, sobald er angezeigt wird. Behandeln Sie ihn als Geheimnis und widerrufen Sie ihn, falls er offengelegt wurde. Prüfen Sie, ob der Schlüssel zum persönlichen Konto oder zum Team gehört.

Die aktuellen öffentlichen Scopes sind files:read and files:upload.

Den Kontokontext abrufen

Setzen Sie SCREENAPP_API_KEY privat in Ihrer Umgebung. Fügen Sie den Schlüssel nicht in clientseitiges HTML ein und committen Sie ihn nicht in ein Repository.

curl --fail-with-body "https://screenapp.io/app/api/v1/me"   -H "x-api-key: $SCREENAPP_API_KEY"

Eine Datei hochladen

Verwenden Sie einen Schlüssel mit Upload-Berechtigung. Ersetzen Sie den lokalen Dateinamen durch Ihre eigene Datei.

curl --fail-with-body "https://screenapp.io/app/api/v1/videos"   -H "x-api-key: $SCREENAPP_API_KEY"   -F "[email protected]"

Die Antwort enthält die Kennung der neuen Datei. Die Verarbeitung läuft im Hintergrund weiter. Fragen Sie GET /app/api/v1/videos/{id} ab, bis transcriptStatus den Wert ready hat, und rufen Sie dann GET /app/api/v1/videos/{id}/transcript auf.

Direkte Uploads über die aktuelle API haben ein Limit von 512 MB für den Request-Body. Das gilt nur für die API: Uploads in der App haben keine feste Dateigrößenbegrenzung. Derselbe videos-Endpunkt akzeptiert statt lokaler Bytes auch ein JSON-Objekt mit einer öffentlichen url.

Aufnahmen abrufen

GET /app/api/v1/videos listet die Aufnahmen im Bereich des Schlüssels.
GET /app/api/v1/videos/{id} liefert Status und Metadaten.
GET /app/api/v1/videos/{id}/transcript liefert das Transkript, sobald es fertig ist.

Verwenden Sie für diese Anfragen die Leseberechtigung. Ein fehlender oder ungültiger Schlüssel ergibt 401, ein unzureichender Scope 403 und eine Ratenbegrenzung 429. Beachten Sie Retry-After, wenn es mitgeliefert wird. Ein Transkript, das vor der Fertigstellung angefragt wird, kann 409 zurückgeben.

Einen Recorder einbetten

Das Einbetten hat eine eigene Einrichtung und eine Domain-Beschränkung. Folgen Sie der Anleitung Recorder einbetten. Geben Sie einen privaten REST-Schlüssel nie als Embed-Token heraus.

Diese Beispiele beschreiben den aktuellen API-Vertrag. Prüfen Sie sie in dem Konto und der Umgebung, die Sie nutzen wollen, bevor Sie eine funktionierende Legacy-Integration ersetzen.