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 mit Webgate.io zu interagieren, musst Du eine OAuth-Anwendung erstellen. Gehe zunächst zu Deinem Profil: Klicke auf das Benutzersymbol in der oberen rechten Ecke und wähle Deinen Namen aus. Auf Deiner Profilseite findest Du ein Kontextmenü, das Optionen zur Verwaltung Deiner OAuth-Anwendungen bietet.

Bei der Erstellung einer OAuth-App wirst Du gebeten, die folgenden Daten anzugeben:

Name

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

Weiterleitungs-URIs

Die OAuth-App erlaubt es dir, mehrere Weiterleitungs-URIs anzugeben. Jede dieser URIs wird verwendet, um die OAuth-App mit einer anderen Anwendung zu integrieren. Für jede angegebene URI wird in Webgate.io eine entsprechende Route erstellt, die zum Starten des Autorisierungsprozesses für einen Webgate.io-Benutzer mit Deiner App verwendet werden kann. Nachdem der Benutzer die App autorisiert hat, wird er an die spezifische URI weitergeleitet, die dieser Route zugeordnet ist.

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.

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. Zum Entwickeln kannst Du auch einen Code generieren, indem Du auf den «Generieren»-Button in unserer Oberfläche klickst.

Um Dich zu authentifizieren, sende die Client-ID, das Client-Geheimnis und den Autorisierungscode an den Token-Endpunkt https://webgate.io/oauth/token. Im Gegenzug erhältst Du ein Zugriffstoken, das Du verwenden kannst, um autorisierte API-Anfragen zu stellen.

Der Autorisierungscode ist temporär und wird gegen ein Zugriffstoken ausgetauscht, das langfristigen Zugriff auf die geschützten Ressourcen gewährt. Das Zugriffstoken wird in den Headers (normalerweise als Bearer-Token) zukünftiger API-Aufrufe verwendet, um auf die geschützten Ressourcen im Namen des Benutzers zuzugreifen.

Das Zugriffstoken läuft nach einer gewissen Zeit ab und muss erneuert werden. Dies geschieht ebenfalls über den oben genannten Token-Endpunkt mit grant_type refresh_token.

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