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.

Recurso	Ações disponíveis
Vídeos	`read`, `create`, `update`, `delete`, `publish`
Eventos Live	`read`, `create`, `update`, `delete`, `publish`
Tags	`create`, `update`, `delete`
Categorias	`create`, `update`, `delete`
Analytics	`read`

O acesso de leitura a categorias e Tags é sempre concedido. Não precisas de o ativar.

publish é separado de create e update. Para vídeos, definir ou alterar visibility para public exige videos.publish. Sem isso, os novos vídeos ficam private e as atualizações de visibilidade são rejeitadas.

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. Se selecionares categorias, a chave só pode aceder a vídeos nessas categorias e nas suas subcategorias. Se deixares o campo vazio, a chave pode aceder a todas as categorias do workspace.

O âmbito de categoria aplica-se a vídeos e a chamadas de analytics por vídeo. Não limita o acesso a eventos live.

Usar uma Chave API

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

CURL


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

JavaScript / Node.js


const response = await fetch('https://app.ignitevideo.cloud/api/videos', {
headers: {
  Authorization: `Bearer YOUR_API_KEY`
}
});

PHP


$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://app.ignitevideo.cloud/api/videos', [
'headers' => [
  'Authorization' => 'Bearer YOUR_API_KEY'
]
]);