Autenticação
Crie uma chave no painel. Abra Integrations & APIs, depois API & SDK e então API keys. A chave completa aparece uma única vez. Ela começa com apk_. Guarde como segredo. Depois disso o painel só conserva um prefixo e os quatro últimos caracteres.
Envie em toda requisição, exceto nas rotas de administração de chaves.
Code
Code
Escopos
Uma chave só chama as rotas que os escopos dela permitem. Escolha o menor conjunto que a integração precisa.
| Escopo | Permite |
|---|---|
read | Listar e ler vídeos, pastas, tags e a configuração do player |
write | Criar, atualizar, excluir, enviar e publicar esses mesmos recursos |
analytics | Rotas de análise em /v1/analytics |
webhooks | Criar e administrar endpoints de webhook |
admin | Administração do workspace. Deixe isso fora de uma chave de integração |
As rotas GET de vídeos, pastas, tags e players exigem read. POST, PATCH, PUT e DELETE nesses recursos exigem write. As análises exigem analytics mesmo quando o método é GET. Os webhooks exigem webhooks em todos os métodos.
Uma chave ausente ou revogada responde 401. Uma chave válida sem o escopo responde 403.
As chaves são administradas com uma sessão
Criar, listar, atualizar e revogar chaves usa a sessão do painel, não uma chave de API. Essas rotas ficam em /v1/workspaces/{workspaceId}/api-keys. Uma chave de API não pode criar outra chave.
Revogar uma chave passa a valer na próxima requisição.