HTTP API
O Alta tem uma HTTP API com requisições e respostas em JSON. Use-a para criar canais, conectar streams de entrada, gerenciar armazenamentos de arquivo e controle de acesso, e ler o estado do serviço a partir do seu sistema de cobrança, do seu middleware ou de scripts.
A interface web do Alta usa a mesma API, então tudo o que você pode fazer na interface também pode ser automatizado.
URL base
Seção intitulada “URL base”Todas as requisições vão para o API Server, não para o OTT Server que atende os espectadores. A porta padrão é 8100. Saiba mais em Servidor HTTP.
http://alta.example.com:8100/api/...Autenticação
Seção intitulada “Autenticação”Toda requisição, exceto /api/login, precisa das credenciais de um usuário do Alta. Há duas formas:
- Bearer token: obtenha um token com
POST /api/logine envie-o no cabeçalhoAuthorization: Bearer <token>. - HTTP Basic: envie o login e a senha do usuário em cada requisição.
Saiba mais em Início Rápido.
Funções
Seção intitulada “Funções”A função do usuário define o que a API permite. As funções são definidas em Usuários.
| Função | Acesso |
|---|---|
admin | Todas as requisições desta seção |
observer | Somente leitura: Status, receptores (GET, status), armazenamento de canais, previews e exportação M3U |
anonymous | Sem acesso. Toda requisição retorna 401 |
Qualquer usuário autenticado pode ler as próprias opções e alterar a própria senha. Veja Usuários.
Requisições e respostas
Seção intitulada “Requisições e respostas”- Envie corpos JSON com o cabeçalho
Content-Type: application/json. - Uma requisição para um único item usa o parâmetro de consulta
id, por exemplo/api/ott/receiver?id=news-hd. - Os IDs de canais e variantes contêm uma barra, por exemplo
discovery/hd. Envie a barra como está ou codificada em URL como%2F. POSTcria um item,PUTo substitui,DELETEo remove. Uma requisiçãoPUTsubstitui todos os campos do item. Envie o objeto completo, não apenas os campos alterados.- Uma requisição bem-sucedida que altera dados retorna
204 No Contentcom o corpo vazio. O Alta salva a configuração antes de responder. - O Alta não tem requisições que retornem listas de canais, receptores ou armazenamentos. Para obter os IDs dos itens, use as requisições de status, por exemplo status do receptor, status do armazenamento e status das sessões.
Códigos de resposta
Seção intitulada “Códigos de resposta”| Código | Descrição |
|---|---|
200 | Sucesso com um corpo |
204 | Sucesso, ou o item não tem nada a retornar, por exemplo um canal sem armazenamento |
400 | O parâmetro id está ausente, ou a requisição é inválida. O corpo pode conter o motivo em texto simples |
401 | Sem credenciais, ou as credenciais estão incorretas |
403 | A função do usuário não permite a requisição. Login ou senha incorretos em /api/login |
404 | O item não existe |
409 | O item já existe, ou um receptor já é usado por outro canal |
422 | O valor de um campo não é válido |
500 | O Alta não conseguiu salvar a configuração |
Recursos
Seção intitulada “Recursos”| Seção | O que você pode fazer |
|---|---|
| Início Rápido | Fazer login e publicar o primeiro canal |
| Status | Ler a versão, o tempo de atividade, a CPU, a memória e o espaço em disco |
| Canais | Criar, alterar, iniciar, parar e excluir canais, e exportar playlists M3U |
| Receptores | Gerenciar streams de entrada e importar canais de uma playlist M3U |
| Armazenamentos | Gerenciar armazenamentos de arquivo e ler o tamanho deles |
| Preview API | Baixar clipes de preview em MP4 do arquivo |
| Autorizadores | Gerenciar regras de acesso e gerar valores de Securetoken |
| Sessões | Ver quem está assistindo agora |
| Acesso HLS | Alterar a duração do segmento e o tamanho da playlist |
| Usuários | Gerenciar usuários e senhas |