Automatyzuj swoje workflowy wideo z Webgate.io API

Webgate.io API umożliwia płynną integrację zaawansowanego zarządzania mediami i automatyzacji z istniejącymi workflowami. Niezależnie od tego, czy musisz przesyłać, przetwarzać i dystrybuować duże ilości plików multimedialnych, czy zarządzać złożonymi zadaniami postprodukcyjnymi, nasze API zapewnia potrzebne możliwości.

Funkcje API w skrócie

Zarządzaj plikami i folderami
Przesyłaj pliki i materiały wideo
Pobieraj pliki i materiały wideo
Odczytuj i zapisuj komentarze
Odczytuj i zapisuj metadane
Zarządzaj użytkownikami i ich uprawnieniami
Wygodna dokumentacja Swagger

Dokumentacja Webgate.io API

Pierwsze kroki z Webgate.io API

Aby zapewnić bezpieczny dostęp do Webgate.io, Twoja aplikacja musi uwierzytelniać się przy użyciu OAuth (Open Authorization). OAuth to branżowy standard, który pozwala aplikacjom działać w imieniu użytkownika bez udostępniania jego danych logowania. Dzięki wydawaniu tokenów OAuth umożliwia bezpieczny, ograniczony zakresem dostęp do chronionych zasobów, gwarantując, że tylko autoryzowane aplikacje mogą wykonywać określone działania. Proces ten chroni dane użytkownika, a jednocześnie nadaje aplikacji uprawnienia, których potrzebuje do działania w określonych granicach.

Utwórz aplikację OAuth

Aby korzystać z OAuth, po stronie Webgate.io najpierw musi zostać utworzona aplikacja OAuth. Może to zrobić wyłącznie support Webgate.io.
Aby poprosić o jej utworzenie, zacznij od przejścia do swojego profilu: kliknij ikonę użytkownika w prawym górnym rogu i wybierz swoje imię. Na stronie profilu znajdziesz menu kontekstowe, które oferuje opcje zarządzania Twoimi aplikacjami OAuth. Stamtąd możesz wysłać wiadomość do supportu Webgate.io z prośbą o utworzenie aplikacji OAuth.
Musisz podać następujące dane:

Nazwa

Nazwa Twojej aplikacji. Powinna być łatwo rozpoznawalna dla użytkowników, którzy będą autoryzować Twoją aplikację.

Owner

Adres e-mail właściciela aplikacji.
Może to być inne konto niż to, z którego składana jest prośba.
Aplikacja OAuth i jej dane będą widoczne tylko na tym koncie.

Redirect URIs

Aby uzyskać oauth grant token, Twoja aplikacja webowa musi wywołać token endpoint w aplikacji Webgate.io, który po autoryzacji aplikacji przez użytkownika przekieruje z powrotem do Twojej aplikacji. Ze względów bezpieczeństwa przekierowanie do Twojej aplikacji musi być skonfigurowane po stronie Webgate.io. Może istnieć jeden albo wiele redirect URI, a redirect URI używany dla konkretnego wywołania autoryzacji podawany jest jako parametr redirect_url.
Jeśli planujesz używać API poza aplikacją webową (np. w skrypcie), możesz pozostawić to pole puste.

Dane aplikacji OAuth

Po utworzeniu aplikacji OAuth Webgate.io udostępnia następujące dane dla Twojej aplikacji OAuth:

Client Id

Client Id to unikalny identyfikator aplikacji OAuth, który pozwala serwerowi autoryzacji ją rozpoznać.

Client Secret

Client Secret to poufny klucz używany przez aplikację OAuth do uwierzytelniania wobec serwera autoryzacji i zapewnienia bezpiecznej komunikacji.

Authorization URLs

Każdy Redirect URI ma unikalny Authorization URL prowadzący do endpointu, do którego użytkownicy są przekierowywani, aby przyznać aplikacji dostęp. Te URL-e obsługują uwierzytelnienie i autoryzację użytkownika, dzięki czemu aplikacja może otrzymać authorization code.

Aby użytkownik mógł autoryzować Twoją aplikację webową do dostępu do Webgate.io, umieść link do authorization URL. Gdy użytkownik otworzy ten link, musi autoryzować Twoją aplikację do dostępu do Webgate.io. Następnie zostanie przekierowany z powrotem do Twojej aplikacji przez redirect url. To przekierowanie przekazuje access grant do Twojej aplikacji. Access grant ma krótki czas życia i musi zostać wymieniony na access token przy użyciu token endpoint, którego możesz używać do wykonywania autoryzowanych żądań API. Access token należy dołączyć do nagłówków (zwykle jako Bearer token) kolejnych wywołań API, aby uzyskać dostęp do chronionych zasobów w imieniu użytkownika. Access token również ma ograniczony czas życia. Do długoterminowego dostępu trzeba uzyskać refresh token (również przez token endpoint), którego można użyć do pobrania nowego access token, gdy bieżący access token wygaśnie.

Skrót do użycia w developmentcie, dokumentacji API i skryptach

Chociaż OAuth zapewnia zdefiniowany sposób integracji aplikacji webowych, przechodzenie przez cały proces może być uciążliwe, gdy chcesz tylko przetestować kilka wywołań API, skorzystać z interaktywnej dokumentacji albo używać API w skrypcie.
Dlatego Webgate.io umożliwia wygenerowanie access grant oraz access i refresh tokenów za pomocą przycisku generate poniżej authorization URLs.
Access token można używać jako authorisation bearer w dokumentacji swagger albo w żądaniach testowych.
Refresh token nadaje się do używania w skryptach. Przed wykonaniem innych wywołań api refresh token musi zostać użyty do utworzenia access token przy pomocy /oauth/token endpoint. Oprócz grant type "refresh_token" i refresh token należy podać także client id oraz client secret.
Pamiętaj, że refresh token i client secret muszą pozostać poufne, aby uniknąć nieautoryzowanego dostępu.

Wysyłaj żądania bezpośrednio w dokumentacji API

Webgate.io używa Swaggera, aby zapewnić rozbudowany interfejs do interakcji ze swoim API. Dzięki dokumentacji Swagger możesz nie tylko zobaczyć wszystkie dostępne endpointy API, ale także wykonywać żądania bezpośrednio z interfejsu. Ułatwia to testowanie i poznawanie funkcjonalności API.

Aby zacząć, musisz najpierw uzyskać access token przy użyciu uwierzytelniania OAuth. Gdy już będziesz mieć token, możesz go używać do uwierzytelniania wszystkich kolejnych żądań API przez dołączenie go do nagłówka Authorization. To upraszcza bezpieczną interakcję z Webgate.io API.

Dokumentacja Webgate.io API