Automatisiere Deine Videoworkflows mit der Webgate.io API

Die Webgate.io API ermöglicht eine nahtlose Integration von leistungsstarkem Medienmanagement und Automatisierung in Deine bestehenden Workflows. Ob Du große Mengen an Mediendateien hochladen, verarbeiten und verteilen musst oder komplexe Postproduktionsaufgaben verwalten möchtest – unsere API bietet dir die nötige Unterstützung.

API-Funktionen auf einen Blick

Verwalte Dateien und Ordner
Dateien und Videomaterial hochladen
Dateien und Videomaterial herunterladen
Kommentare lesen und schreiben
Metadaten lesen und schreiben
Benutzer und deren Berechtigungen verwalten
Einfache Swagger-Dokumentation

Webgate.io API-Dokumentation

Erste Schritte mit der Webgate.io API

Um einen sicheren Zugriff auf Webgate.io zu gewährleisten, muss Deine Anwendung OAuth (Open Authorization) verwenden. OAuth ist ein branchenüblicher Standard, der es Anwendungen ermöglicht, im Namen eines Benutzers mit einem Dienst zu interagieren, ohne deren Anmeldedaten preiszugeben. Durch die Vergabe von Token ermöglicht OAuth einen sicheren, abgestuften Zugriff auf geschützte Ressourcen und stellt sicher, dass nur autorisierte Anwendungen bestimmte Aktionen durchführen dürfen. Dieser Prozess schützt Benutzerdaten, während der Anwendung die benötigten Berechtigungen innerhalb festgelegter Grenzen erteilt werden.

Erstelle eine OAuth App

Um OAuth zu nutzen, muss zunächst im Webgate.io eine OAuth-Anwendung angelegt werden. Das kann nur der Webgate.io Support machen.
Um die Erstellung anzufordern, navigiere zunächst zu deinem Profil: Klicke auf das Benutzersymbol in der oberen rechten Ecke und wähle deinen Namen. Auf Ihrer Profilseite findst du ein Kontextmenü, das Optionen für die Verwaltung deiner OAuth-Anwendungen bietet. Hier kannst du eine Nachricht an den Webgate.io Support senden, um eine OAuth-Anwendung anzufordern.
Du musst die folgenden Daten angeben:

Name

Der Name Deiner Anwendung. Er sollte für Deine Benutzer leicht erkennbar sein, die Deine App autorisieren möchten.

Owner

Email-Addresse des Nutzers, dem die Application gehört.
Das kann ein anderer Account sein, als der, der die Anfrage stellt.
Die OAuth Anwendung und ihre Daten werden nur im Owner-Account angezeigt.

Weiterleitungs-URIs

Um ein Oauth-Grant-Token zu erhalten, muss deine Webanwendung einen Token-Endpunkt in der Webgate.io-Anwendung aufrufen, der nach der Autorisierung der Anwendung durch die Benutzer:in zu deiner Anwendung zurückleitet. Aus Sicherheitsgründen muss der Redirect zu deiner Anwendung auf der Webgate.io-Seite konfiguriert sein. Es können ein oder mehrere Redirect-URIs angegeben werden. Die Redirect-URI, die für einen bestimmten Autorisierungsaufruf verwendet werden soll, wird als redirect_url-Parameter angegeben.
Wenn du die API nur außerhalb einer Webanwendung (z.B. in einem Skript) verwenden möchtest, kannst du diesen Parameter leer lassen.

Erteile Deiner App eine Zugriffsberechtigung

Sobald Du eine OAuth-App erstellt hast, stellt dir Webgate.io die folgenden Daten zur Autorisierung bereit:

Client-ID

Die Client-ID ist ein eindeutiger Identifikator für eine OAuth-Anwendung, der es ihr ermöglicht, vom Autorisierungsserver erkannt zu werden.

Client-Geheimnis

Das Client-Geheimnis ist ein vertraulicher Schlüssel, der von einer OAuth-Anwendung verwendet wird, um sich beim Autorisierungsserver zu authentifizieren und eine sichere Kommunikation zu gewährleisten.

Authorisierungs-URLs

Jede Weiterleitungs-URI hat eine eindeutige Autorisierungs-URL, die auf einen Endpunkt verweist, an den Benutzer weitergeleitet werden, um einer Anwendung Zugriff zu gewähren. Diese URLs verwalten die Benutzer-Authentifizierung und -Autorisierung, sodass die App einen Autorisierungscode erhält.

Damit Nutzer:innen deine Webanwendung für den Zugriff auf Webgate.io autorisieren können, verlinkst du auf die Autorisierungs-URL. Wenn eine Benutzer:in diesem Link folgt, muss sie deine Anwendung für den Zugriff auf Webgate.io autorisieren. Anschließend wird sie über die Redirect-URL zu deine Anwendung zurückgeleitet. Dabei wird ein Access Grant an deine Anwendung übergeben.
Der Access Grant hat eine kurze Lebensdauer und muss über den Token-API-Endpunkt in ein Access Token umgewandelt werden, das du dann für autorisierte API-Anfragen verwenden kannst.
Das Access Token musst du in den Header (normalerweise als Bearer-Token) nachfolgender API-Aufrufe einfügen, um im Namen des Benutzers auf geschützte Ressourcen zuzugreifen.
Das Zugriffstoken hat auch nur eine begrenzte Lebensdauer. Für einen langfristigen Zugriff muss ein Refresh-Token angefordert werden (ebenfalls über den Token-Endpunkt), mit dem ein neues Access-Token angefordert werden kann, wenn das aktuelle Access-Token abläuft.

Abkürzung zur Verwendung in der Entwicklung, der API Dokumentation und Skripten

Während OAuth einen vorgegebenen Weg zur Integration von Web Anwendungen vorzieht, kann es mühsam sein, dem zu folgen, wenn man nur einige API Aufrufe ausprobieren, die interaktive Dokumentation nutzen oder die API in einem Skript verwenden will.
Deshalb bietet Webgate.io an, einen Access Grant und Access und Refresh Token mit Hilfe eines Buttons unter den Authorisation URLs zu erzeugen.
Das Access Token kann als authorisation bearer in der swagger Dokumenation oder Test-Aufrufen verwenden werden.
Das Refresh-Token lässt sich in Skripten verwenden. Bevor API-Aufrufe gemacht werden, muss es mit Hilfe des /oauth/token-Endpunktes in ein Access Token umgewandelt werden. Dabei muss neben dem Grant Typ "refresh_token" und dem Refresh-Token auch die Client-ID und das Client-Geheimnis angegeben werden.
Denke bitte daran, dass das Refresh-Token und Client-Geheimnis vertraulich bleiben müssen um unerlaubten Zugriff zu verhindern.

Sende Anfragen direkt in der API-Dokumentation

Webgate.io verwendet Swagger, um eine umfassende Schnittstelle für die Interaktion mit seiner API bereitzustellen. Über die Swagger-Dokumentation kannst Du nicht nur alle verfügbaren API-Endpunkte einsehen, sondern auch direkt aus der Oberfläche Anfragen ausführen. Dies erleichtert das Testen und Erkunden der API-Funktionalitäten.

Um zu beginnen, musst Du zuerst ein Zugriffstoken mithilfe der OAuth-Authentifizierung erhalten. Sobald Du das Token hast, kannst Du es verwenden, um alle weiteren API-Anfragen zu authentifizieren, indem Du es im Autorisierungs-Header einfügst. Dies vereinfacht die sichere Interaktion mit der Webgate.io API.

Webgate.io API-Dokumentation