ativeaqui / desenvolvedores
Módulo de Players · API v1

Integre aparelhos e playlists
com segurança.

Gerencie os aparelhos da sua conta, confira as listas nos aplicativos e acompanhe operações em fila. Esta página reúne o guia, a referência interativa e os arquivos para ferramentas de IA.

Primeiros passos

1

Ative sua assinatura

O módulo precisa estar ativo. Planos pagos e o teste grátis usam a abertura global da API (no teste, as chaves param quando ele acaba); contas de cortesia precisam de liberação individual do administrador.

2

Crie uma chave

Em Painel › API de Players, escolha os escopos necessários. Copie a chave ao criar: ela aparece uma única vez.

3

Faça a primeira leitura

Use Authorization: Bearer e consulte GET /me. Depois, liste seus aparelhos em GET /devices.

Primeira chamada

A URL base é https://ativeaqui.com/api/v1/players.

curl --request GET \
  'https://ativeaqui.com/api/v1/players/me' \
  --header 'Authorization: Bearer SUA_CHAVE'

A resposta informa acesso, assinatura e cota disponível.

Escritas são assíncronas

Enviar→202 + ID→Consultar status

Envie uma Idempotency-Key nova para cada mutação. Consulte GET /operations/{operation_id} a cada 5 segundos. Uma resposta review exige conferir o aparelho antes de outra escrita.

Não repita automaticamente uma escrita após timeout. Consulte a operação original usando a mesma chave de idempotência.

O botão “Execute” do Swagger pode alterar aparelhos reais.

As rotas de envio, edição, exclusão e troca de DNS atuam nos aplicativos. Use um aparelho de teste e confira o alcance da chave. A autorização preenchida no Swagger fica apenas na página aberta e não é preservada após recarregar.

Limites: 20 chamadas por minuto por chave, até 10 escritas por minuto por conta, além da cota diária de operações remotas. Respeite o cabeçalho Retry-After em HTTP 429.

Escopos

  • devices:read e devices:write: cadastro local.
  • devices:sync: leitura no aplicativo.
  • playlists:read e playlists:write: listas.
  • dns:write: troca de DNS em lote.
  • operations:read: andamento e resultado.

Arquivos para integração

A documentação descreve a API da sua conta. Ela não expõe chaves, URLs completas de playlists nem dados de outras contas.

Referência interativa

Endpoints, parâmetros, modelos e respostas gerados a partir do OpenAPI.

OpenAPI YAML ↓

Carregando a referência…