Automatiseer je videoworkflows met de Webgate.io API

Met de Webgate.io API kun je krachtig mediabeheer en automatisering naadloos in je bestaande workflows integreren. Of je nu grote hoeveelheden mediabestanden moet uploaden, verwerken en distribueren of complexe postproductietaken moet beheren: onze API ondersteunt je daarbij.

API-functies in het kort

Bestanden en mappen beheren
Bestanden en videomateriaal uploaden
Bestanden en videomateriaal downloaden
Reacties lezen en schrijven
Metadata lezen en schrijven
Gebruikers en hun rechten beheren
Eenvoudige Swagger-documentatie

Webgate.io API Documentation

Aan de slag met de Webgate.io API

Om veilige toegang tot Webgate.io te garanderen, moet je applicatie authenticeren via OAuth (Open Authorization). OAuth is een industriestandaardprotocol waarmee applicaties namens een gebruiker met een service kunnen communiceren zonder diens inloggegevens te delen. Door tokens uit te geven maakt OAuth veilige, afgebakende toegang tot beschermde resources mogelijk, zodat alleen geautoriseerde applicaties bepaalde acties kunnen uitvoeren. Dit proces beschermt gebruikersdata en geeft de applicatie tegelijk de rechten die nodig zijn om binnen vastgelegde grenzen te werken.

Een OAuth App aanmaken

Om OAuth te gebruiken, moet eerst aan Webgate.io-zijde een OAuth-applicatie worden aangemaakt. Dit kan alleen door de Webgate.io-support worden gedaan.
Om de aanmaak aan te vragen, ga je eerst naar je profiel: klik rechtsboven op het gebruikersicoon en selecteer je naam. Op je profielpagina vind je een contextmenu met opties voor het beheren van je OAuth-applicaties. Hier kun je een bericht naar de Webgate.io-support sturen om een OAuth-applicatie aan te vragen.
Je moet de volgende gegevens opgeven:

Naam

De naam van je applicatie. Deze moet gemakkelijk herkenbaar zijn voor gebruikers die je app gaan autoriseren.

Eigenaar

E-mailadres van de eigenaar van de applicatie.
Dit kan een ander account zijn dan het account dat de applicatie aanvraagt.
De OAuth-applicatie en de bijbehorende data worden alleen in dat account getoond.

Redirect URIs

Om een OAuth grant token te krijgen, moet je webapplicatie de token endpoint in de Webgate.io-applicatie aanroepen, die na autorisatie door de gebruiker terugverwijst naar je applicatie. Om veiligheidsredenen moet de redirect naar je applicatie aan Webgate.io-zijde worden geconfigureerd. Er kunnen een of meerdere Redirect URIs zijn; de Redirect URI die voor een specifieke autorisatieaanroep wordt gebruikt, wordt als redirect_url-parameter meegegeven.
Als je de API buiten een webapplicatie wilt gebruiken (bijv. in een script), kun je dit leeg laten.

OAuth-applicatiegegevens

Zodra je een OAuth App hebt aangemaakt, stelt Webgate.io de volgende gegevens voor je OAuth-applicatie beschikbaar:

Client-ID

De Client Id is een unieke identificatie voor een OAuth-applicatie, waarmee deze door de authorization server kan worden herkend.

Client Secret

De Client Secret is een vertrouwelijke sleutel die door een OAuth-applicatie wordt gebruikt om zichzelf bij de authorization server te authenticeren en veilige communicatie te garanderen.

Authorization URLs

Elke Redirect URI heeft een unieke Authorization URL die verwijst naar een endpoint waar gebruikers naartoe worden geleid om een applicatie toegang te geven. Deze URLs verwerken gebruikersauthenticatie en autorisatie, zodat de app een authorization code kan ontvangen.

Om je webapplicatie door de gebruiker te laten autoriseren voor toegang tot Webgate.io, link je naar de authorization URL. Wanneer de gebruiker deze link volgt, moet hij of zij je applicatie autoriseren voor toegang tot Webgate.io. Daarna wordt de gebruiker via de redirect url teruggeleid naar je applicatie. Deze redirect geeft een access grant door aan je applicatie. Deze access grant is kort geldig en moet via de token endpoint worden ingewisseld voor een access token, dat je kunt gebruiken om geautoriseerde API requests te doen. Je neemt het access token op in de headers (meestal als Bearer token) van volgende API-calls om namens de gebruiker toegang te krijgen tot beschermde resources. Het access token heeft nog steeds een beperkte levensduur. Voor langdurige toegang moet een refresh token worden verkregen (ook via de token endpoint), waarmee een nieuw access token kan worden aangevraagd wanneer het huidige access token verloopt.

Shortcut voor gebruik in development, API docs en scripts

Hoewel OAuth een gedefinieerde manier biedt om webapplicaties te integreren, kan het omslachtig zijn om het volledige proces te doorlopen als je alleen enkele API-calls wilt uitproberen, de interactieve documentatie wilt gebruiken of de API vanuit een script wilt aanroepen.
Daarom biedt Webgate.io de mogelijkheid om via de generate-knop onder de authorization URLs een access grant en access en refresh tokens te genereren.
Het access token kan als authorization bearer in de Swagger-doc of in testrequests worden gebruikt.
Het refresh token is geschikt voor gebruik in scripts. Voordat andere API-calls worden gedaan, moet het refresh token worden gebruikt om via de /oauth/token endpoint een access token aan te maken. Naast het grant type "refresh_token" en het refresh token moeten ook de client id en client secret worden opgegeven.
Houd er rekening mee dat het refresh token en de client secret geheim moeten blijven om ongeautoriseerde toegang te voorkomen.

Requests direct in de API Documentation uitvoeren

Webgate.io gebruikt Swagger om een uitgebreide interface voor interactie met de API te bieden. Via de Swagger-documentatie kun je niet alleen alle beschikbare API endpoints bekijken, maar ook direct vanuit de interface requests uitvoeren. Zo kun je de functionaliteit van de API eenvoudig testen en verkennen.

Om te beginnen moet je eerst via OAuth-authenticatie een access token verkrijgen. Zodra je het token hebt, kun je dit gebruiken om alle volgende API requests te authenticeren door het in de Authorization header op te nemen. Dit stroomlijnt het proces om veilig met de Webgate.io API te werken.

Webgate.io API Documentation