Skip to Content
Referência APIAutenticação

Autenticação

Obter uma Chave API

Podes criar uma Chave API na página Integrações API  na IU Admin do Ignite. Precisas de um papel admin para acederes a esta página.

Quando crias uma chave, escolhe as suas permissões e um âmbito de categoria opcional.

Permissões

As permissões da Chave API são concedidas por recurso. Ativa apenas as ações de que a tua integração precisa.

RecursoAções disponíveis
Vídeosread, create, update, delete, publish
Eventos Liveread, create, update, delete, publish
Tagscreate, update, delete
Categoriascreate, update, delete
Analyticsread

O acesso de leitura a categorias, Tags e presets do leitor é sempre concedido. Não precisas de o ativar. As Chaves API não podem criar, atualizar nem eliminar presets do leitor.

publish é separado de create e update. visibility: public só é gravado quando a chave tem videos.publish. Sem isso, a criação grava private. Um PATCH que define visibility é aceite, o campo permanece inalterado e a resposta mantém-se 200. Nenhum dos casos devolve 403.

Os endpoints de Analytics exigem analytics.read. Apenas read em vídeos não chega. Vê Analytics.

As Chaves API não podem gerir membros, webhooks, outras integrações API nem definições da conta.

Âmbito de categoria

Podes limitar uma Chave API a uma ou mais categorias. O âmbito inclui essas categorias e as suas subcategorias. Filtra as leituras e escritas de vídeos e as leituras, atualizações e eliminações de categorias. Uma chave com âmbito não pode eliminar uma categoria que seja uma das suas âncoras de âmbito. Se criares um vídeo e não enviares categorias, são atribuídas as categorias do âmbito, até 10. Se deixares o campo vazio, a chave pode aceder a todas as categorias do workspace.

O âmbito de categoria não limita Tags nem eventos live. Aplica-se às chamadas de analytics por vídeo.

Usar uma Chave API

Passa a tua Chave API como Token Bearer no cabeçalho Authorization do teu pedido.

curl -X GET https://app.ignitevideo.cloud/api/videos \ -H "Authorization: Bearer YOUR_API_KEY"

Chave API em falta ou inválida

Uma Chave API em falta ou inválida devolve 403:

{ "errors": [ { "message": "You are not allowed to perform this action" } ] }

Formas de resposta de erro

Os endpoints de coleção (vídeos, categorias, Tags e presets do leitor) devolvem erros do Payload como { errors: [{ message }] }.

Os endpoints personalizados (upload, replace, miniaturas, Text tracks, multipart upload e rotas de IA) devolvem { error, message? }. message é omitido em alguns erros. Uma falha de permissão nessas rotas devolve 403.

{ "error": "not_found" }
{ "error": "invalid_video_id" }

Um campo que falha a validação num endpoint de coleção devolve 400 com a forma de erro do Payload.

O GET de um vídeo, categoria ou tag em falta devolve 404 { errors: [{ message: "Not Found" }] }. O PATCH ou DELETE de um id em falta devolve 403 com o erro do Payload acima. A resposta é a mesma quando o documento não existe e quando a chave não tem permissão para o ver.