Pular para o conteúdo
Produtos

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.

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/...

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/login e envie-o no cabeçalho Authorization: Bearer <token>.
  • HTTP Basic: envie o login e a senha do usuário em cada requisição.

Saiba mais em Início Rápido.

A função do usuário define o que a API permite. As funções são definidas em Usuários.

FunçãoAcesso
adminTodas as requisições desta seção
observerSomente leitura: Status, receptores (GET, status), armazenamento de canais, previews e exportação M3U
anonymousSem 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.

  • 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.
  • POST cria um item, PUT o substitui, DELETE o remove. Uma requisição PUT substitui 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 Content com 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ódigoDescrição
200Sucesso com um corpo
204Sucesso, ou o item não tem nada a retornar, por exemplo um canal sem armazenamento
400O parâmetro id está ausente, ou a requisição é inválida. O corpo pode conter o motivo em texto simples
401Sem credenciais, ou as credenciais estão incorretas
403A função do usuário não permite a requisição. Login ou senha incorretos em /api/login
404O item não existe
409O item já existe, ou um receptor já é usado por outro canal
422O valor de um campo não é válido
500O Alta não conseguiu salvar a configuração
SeçãoO que você pode fazer
Início RápidoFazer login e publicar o primeiro canal
StatusLer a versão, o tempo de atividade, a CPU, a memória e o espaço em disco
CanaisCriar, alterar, iniciar, parar e excluir canais, e exportar playlists M3U
ReceptoresGerenciar streams de entrada e importar canais de uma playlist M3U
ArmazenamentosGerenciar armazenamentos de arquivo e ler o tamanho deles
Preview APIBaixar clipes de preview em MP4 do arquivo
AutorizadoresGerenciar regras de acesso e gerar valores de Securetoken
SessõesVer quem está assistindo agora
Acesso HLSAlterar a duração do segmento e o tamanho da playlist
UsuáriosGerenciar usuários e senhas