Automatiza os teus workflows de vídeo com a API do Webgate.io

A API do Webgate.io permite uma integração fluida de gestão multimédia poderosa e automação nos teus workflows existentes. Quer precises de carregar, processar e distribuir grandes quantidades de ficheiros multimédia ou de gerir tarefas complexas de pós-produção, a nossa API oferece o suporte necessário.

Funções da API num relance

Gere ficheiros e pastas
Carrega ficheiros e material de vídeo
Descarrega ficheiros e material de vídeo
Ler e escrever comentários
Ler e escrever metadados
Gerir utilizadores e as respetivas permissões
Documentação Swagger simples

Documentação da API do Webgate.io

Primeiros passos com a API do Webgate.io

Para garantir um acesso seguro ao Webgate.io, a tua aplicação tem de utilizar OAuth (Open Authorization). O OAuth é um padrão comum da indústria que permite às aplicações interagir com um serviço em nome de um utilizador sem expor as respetivas credenciais. Ao atribuir tokens, o OAuth possibilita um acesso seguro e gradual a recursos protegidos e garante que apenas aplicações autorizadas podem executar determinadas ações. Este processo protege os dados dos utilizadores, ao mesmo tempo que concede à aplicação as permissões necessárias dentro de limites definidos.

Cria uma app OAuth

Para utilizar OAuth, primeiro é necessário criar uma aplicação OAuth no Webgate.io. Isto só pode ser feito pelo suporte do Webgate.io.

Para solicitar a criação, navega primeiro até ao teu perfil: clica no ícone do utilizador no canto superior direito e seleciona o teu nome. Na tua página de perfil encontrarás um menu de contexto com opções para gerir as tuas aplicações OAuth. Aí podes enviar uma mensagem ao suporte do Webgate.io para solicitar uma aplicação OAuth.

Tens de fornecer os seguintes dados:

Nome

O nome da tua aplicação. Deve ser facilmente reconhecível para os teus utilizadores quando quiserem autorizar a tua app.

Owner

Endereço de e-mail do utilizador ao qual pertence a aplicação.
Pode ser uma conta diferente daquela que faz o pedido.
A aplicação OAuth e os respetivos dados só são mostrados na conta do Owner.

URIs de redirecionamento

Para obter um token OAuth grant, a tua aplicação web tem de chamar um endpoint de token na aplicação Webgate.io que, depois da autorização da aplicação pela pessoa utilizadora, a redireciona de volta para a tua aplicação. Por razões de segurança, o redirecionamento para a tua aplicação tem de estar configurado no lado do Webgate.io. Podes indicar um ou vários redirect URIs. O redirect URI a utilizar numa determinada chamada de autorização é passado como parâmetro `redirect_url`.
Se quiseres usar a API apenas fora de uma aplicação web (por exemplo, num script), podes deixar este parâmetro vazio.

Concede autorização de acesso à tua app

Assim que criares uma app OAuth, o Webgate.io disponibiliza-te os seguintes dados para autorização:

Client ID

O Client ID é um identificador único de uma aplicação OAuth que permite ao servidor de autorização reconhecê-la.

Segredo do cliente

O segredo do cliente é uma chave confidencial utilizada por uma aplicação OAuth para se autenticar junto do servidor de autorização e garantir uma comunicação segura.

URLs de autorização

Cada redirect URI tem um URL de autorização único que aponta para um endpoint para o qual os utilizadores são redirecionados para conceder acesso a uma aplicação. Estes URLs tratam da autenticação e autorização do utilizador, para que a app receba um código de autorização.

Para que os utilizadores possam autorizar a tua aplicação web a aceder ao Webgate.io, colocas um link para o URL de autorização. Se uma pessoa utilizadora seguir esse link, terá de autorizar a tua aplicação a aceder ao Webgate.io. Em seguida, será redirecionada para a tua aplicação através do redirect URL. Nessa altura, é transmitido à tua aplicação um access grant.

O access grant tem uma duração curta e tem de ser convertido num access token através do endpoint Token API, que depois podes utilizar para pedidos API autorizados.

Tens de inserir o access token no header (normalmente como bearer token) das chamadas API subsequentes para aceder a recursos protegidos em nome do utilizador.

O access token também tem uma duração limitada. Para acesso a longo prazo, deve ser solicitado um refresh token (também através do endpoint de token), que pode ser utilizado para pedir um novo access token quando o access token atual expirar.

Atalho para utilização no desenvolvimento, na documentação da API e em scripts

Embora o OAuth prefira um caminho definido para a integração de aplicações web, pode ser trabalhoso segui-lo quando apenas se quer experimentar algumas chamadas API, utilizar a documentação interativa ou usar a API num script.

Por isso, o Webgate.io oferece a possibilidade de gerar um access grant e access e refresh tokens com a ajuda de um botão por baixo dos URLs de autorização.

O access token pode ser utilizado como bearer de autorização na documentação Swagger ou em chamadas de teste.

O refresh token pode ser utilizado em scripts. Antes de efetuar chamadas API, tem de ser convertido num access token através do endpoint /oauth/token. Envia o Client ID e o segredo do cliente como autenticação HTTP Basic no cabeçalho Authorization, e o tipo de grant `refresh_token` juntamente com o refresh token no corpo do pedido. Nunca no URL — as query strings acabam nos registos do servidor.

Lembra-te de que o refresh token e o segredo do cliente devem permanecer confidenciais para evitar acessos não autorizados.

Envia pedidos diretamente na documentação da API

O Webgate.io utiliza Swagger para disponibilizar uma interface abrangente para a interação com a sua API. Através da documentação Swagger, não só podes ver todos os endpoints API disponíveis, como também executar pedidos diretamente a partir da interface. Isso facilita o teste e a exploração das funcionalidades da API.
Para começar, tens primeiro de obter um access token com a ajuda da autenticação OAuth. Assim que tiveres o token, podes utilizá-lo para autenticar todos os pedidos API seguintes, inserindo-o no header de autorização. Isto simplifica a interação segura com a API do Webgate.io.

Documentação da API do Webgate.io