Leia toda a API antes de solicitar

A referência do Engine é aberta. Recursos, campos e erros estão documentados com exemplos, e nada fica atrás de um formulário. Quando quiser testar uma chamada, solicite uma conta e crie uma chave de sandbox.

Para ler
Sem precisar de conta
Formato
Referência REST com exemplos
Chaves de sandbox
Com uma conta aprovada

Comece com uma requisição

O jeito mais rápido de conhecer uma API é chamá-la. Estas quatro requisições são uma boa primeira hora: confirmar que a sua chave funciona, listar o que existe, criar um lançamento e assinar eventos.

  • Cada endpoint é mostrado com uma requisição e uma resposta
  • Os erros são listados com a causa e a correção
  • Os exemplos funcionam no sandbox exatamente como estão escritos

Primeiras requisições

Exemplos de requisições

GET/v1/me

Resposta

{  "id": "acc_5t1m9",  "name": "Northfield Audio",  "environment": "sandbox"}

A referência, por recurso

Lançamentos
Crie, atualize, envie e remova lançamentos, com seus territórios e datas.
Faixas e arquivos
Adicione faixas, envie áudio e capa e defina créditos, códigos e splits.
Entregas
Envie um lançamento às lojas e acompanhe cada destino da fila até o ar ou a recusa.
Análises
Leia streams e downloads por loja, território, lançamento, faixa e dia.
Royalties
Liste extratos, leia suas linhas e veja o que cada beneficiário tem a receber.
Webhooks
Registre um endpoint, escolha os eventos que ele recebe e revise o que foi enviado.

Início rápido, no sandbox

  1. 1

    Crie uma chave de sandbox

    Solicite uma conta e, depois que ela for aprovada, copie a chave dela.

  2. 2

    Faça sua primeira requisição

    Chame /v1/me com a chave no cabeçalho Authorization para confirmar que funciona.

  3. 3

    Crie um lançamento de teste

    Envie um lançamento com título e artista e depois adicione uma faixa a ele.

  4. 4

    Simule uma entrega

    Entregue no sandbox e acompanhe o status avançar, sem nenhuma loja envolvida.

Um cabeçalho e você está dentro

A autenticação é uma chave de API enviada como bearer token. Não há handshake nem sessão para manter ativa. Copie isto, coloque a sua chave e execute.

  • Sandbox e produção usam chaves separadas
  • Uma chave pode ser revogada a qualquer momento

Liste os seus lançamentos

bash
curl https://api.aevorarecords.com/v1/releases \  -H "Authorization: Bearer YOUR_API_KEY"

Perguntas sobre a documentação

Não. A referência é pública. Você só precisa de uma conta quando quiser uma chave.

Os endpoints e as respostas são os mesmos. As entregas no sandbox param antes de qualquer loja, e os dados do sandbox ficam separados do seu catálogo real.

As adições são registradas no changelog. Uma mudança incompatível é publicada em uma nova versão no caminho, e a versão com a qual você desenvolveu continua como está.

Leia primeiro, depois faça uma requisição