Automatizujte své video workflow pomocí Webgate.io API

Webgate.io API umožňuje bezproblémovou integraci výkonné správy médií a automatizace do vašich stávajících workflow. Ať už potřebujete nahrávat, zpracovávat a distribuovat velké objemy mediálních souborů, nebo spravovat složité postprodukční úkoly, naše API vám poskytne potřebné možnosti.

Funkce API v kostce

Správa souborů a složek
Upload souborů a video materiálu
Download souborů a video materiálu
Čtení a zápis komentářů
Čtení a zápis metadat
Správa uživatelů a jejich oprávnění
Jednoduchá Swagger dokumentace

Webgate.io API dokumentace

Jak začít s Webgate.io API

Pro zajištění bezpečného přístupu k Webgate.io se vaše aplikace musí autentizovat pomocí OAuth (Open Authorization). OAuth je průmyslový standard, který umožňuje aplikacím komunikovat se službou jménem uživatele, aniž by sdílely jeho přihlašovací údaje. Pomocí tokenů umožňuje OAuth bezpečný, omezený přístup k chráněným zdrojům a zajišťuje, že určité akce mohou provádět pouze autorizované aplikace. Tento proces chrání uživatelská data a zároveň aplikaci poskytuje oprávnění, která potřebuje v rámci jasně definovaných hranic.

Vytvořte OAuth App

Aby bylo možné OAuth používat, je nejprve potřeba vytvořit OAuth aplikaci na straně Webgate.io. To může provést pouze podpora Webgate.io.
Chcete-li o vytvoření požádat, přejděte nejprve do svého profilu: klikněte na ikonu uživatele v pravém horním rohu a vyberte své jméno. Na stránce profilu najdete kontextové menu s možnostmi správy vašich OAuth aplikací. Odtud můžete poslat zprávu podpoře Webgate.io a požádat o vytvoření OAuth aplikace.
Musíte uvést následující údaje:

Název

Název vaší aplikace. Měl by být snadno rozpoznatelný pro uživatele, kteří budou vaši app autorizovat.

Owner

E-mailová adresa vlastníka aplikace.
Může jít o jiný účet než ten, ze kterého je žádost o aplikaci podána.
OAuth aplikace a její data se zobrazí pouze v tomto účtu.

Redirect URIs

Aby vaše webová aplikace získala oauth grant token, musí volat token endpoint ve Webgate.io aplikaci, který po autorizaci aplikace uživatelem přesměruje zpět do vaší aplikace. Z bezpečnostních důvodů musí být redirect do vaší aplikace nakonfigurován na straně Webgate.io. Může existovat jedna nebo více redirect URI. Redirect URI použitá pro konkrétní autorizační volání se předává jako parametr redirect_url.
Pokud plánujete používat API mimo webovou aplikaci (např. ve skriptu), můžete toto pole nechat prázdné.

Autorizační údaje OAuth aplikace

Jakmile je OAuth App vytvořena, poskytne vám Webgate.io následující údaje pro vaši OAuth aplikaci:

Client Id

Client Id je jedinečný identifikátor OAuth aplikace, díky němuž ji autorizační server dokáže rozpoznat.

Client Secret

Client Secret je důvěrný klíč, který OAuth aplikace používá k ověření vůči autorizačnímu serveru a tím zajišťuje bezpečnou komunikaci.

Authorization URLs

Každá Redirect URI má jedinečnou Authorization URL, která vede na endpoint, kam jsou uživatelé přesměrováni, aby aplikaci udělili přístup. Tyto URL zajišťují autentizaci a autorizaci uživatele a umožňují aplikaci získat authorization code.

Aby uživatel autorizoval vaši webovou aplikaci pro přístup k Webgate.io, musíte odkázat na authorization URL. Když uživatel tento odkaz otevře, musí vaší aplikaci povolit přístup k Webgate.io. Poté je pomocí redirect url přesměrován zpět do vaší aplikace. Toto přesměrování předá vaší aplikaci access grant. Tento access grant má krátkou platnost a je potřeba jej vyměnit za access token pomocí token endpointu, který pak můžete použít pro autorizované API požadavky. Access token následně vkládáte do hlaviček (obvykle jako Bearer token) dalších API volání, abyste jménem uživatele získali přístup k chráněným zdrojům. I access token má omezenou životnost. Pro dlouhodobý přístup je potřeba získat refresh token (také přes token endpoint), který lze použít k vyžádání nového access tokenu, když aktuální access token vyprší.

Zkratka pro použití při vývoji, v API dokumentaci a ve skriptech

Přestože OAuth definuje jasný způsob integrace webových aplikací, může být zdlouhavé procházet celý proces pokaždé, když si chcete jen vyzkoušet několik API volání, použít interaktivní dokumentaci nebo využít API ze skriptu.
Proto Webgate.io nabízí možnost vygenerovat access grant a access i refresh tokeny pomocí tlačítka pod authorization URLs.
Access token lze použít jako authorization bearer ve Swagger dokumentaci nebo v testovacích požadavcích.
Refresh token je vhodný pro použití ve skriptech. Před dalším API voláním je potřeba refresh token použít k vytvoření access tokenu pomocí /oauth/token endpointu. Kromě grant typu "refresh_token" a samotného refresh tokenu je nutné zadat také client id a client secret.
Mějte na paměti, že refresh token i client secret musí zůstat tajné, aby nedošlo k neoprávněnému přístupu.

Odesílejte požadavky přímo v API dokumentaci

Webgate.io používá Swagger jako komplexní rozhraní pro práci se svou API. Prostřednictvím Swagger dokumentace si můžete nejen zobrazit všechny dostupné API endpointy, ale také z rozhraní přímo odesílat požadavky. To výrazně usnadňuje testování a zkoumání funkcí API.

Pro začátek je potřeba nejprve získat access token pomocí OAuth autentizace. Jakmile token získáte, můžete jej použít k autorizaci všech dalších API požadavků tím, že jej vložíte do hlavičky Authorization. Tím se celý proces bezpečné komunikace s Webgate.io API výrazně zjednoduší.

Webgate.io API dokumentace