Opere a distribuição dentro do seu próprio produto

O Engine é a API da Aevora. Crie lançamentos, entregue-os às lojas, leia análises e execute royalties via REST, dentro do produto que seus clientes já usam. A documentação é pública e há um sandbox para você desenvolver.

Interface
REST e JSON
Autenticação
Chaves de API, um conjunto por ambiente
Sandbox
Entregas de teste, sem lojas envolvidas

Quatro chamadas levam um lançamento do rascunho ao extrato

A API segue o caminho que um lançamento percorre no painel: criar, entregar, ler os números conforme chegam e, por fim, ler o extrato. Escolha uma chamada para ver o que você envia e o que recebe de volta.

  • Requisições e respostas são em JSON
  • Um erro indica o campo que falhou e o motivo
  • As mesmas chamadas funcionam no sandbox e em produção

API Engine

Exemplos de requisições

POST/v1/releases

Corpo da requisição

{  "title": "Night Drive",  "artist": "Mira Kaya",  "label": "Northfield Audio",  "release_date": "2027-03-12"}

Resposta

{  "id": "rel_8f2k1",  "status": "draft",  "upc": null}

O que existe em volta dos endpoints

As chamadas são a parte curta de uma integração. Estes são os recursos que a mantêm funcionando quando ninguém está olhando.

Webhooks
Receba um evento quando uma entrega mudar de estado, um lançamento entrar no ar ou um extrato ficar pronto, sem precisar consultar a API repetidamente.
Chaves de idempotência
Envie uma chave em uma requisição de escrita e uma nova tentativa devolve o primeiro resultado, em vez de criar um segundo lançamento.
Paginação
As listas devolvem um cursor. Envie-o de volta para obter a página seguinte, sempre na mesma ordem.
Sandbox
Um ambiente separado, com chaves próprias. As entregas percorrem todo o fluxo e param antes de chegar a qualquer loja.
Versionamento
A versão faz parte do caminho. Uma mudança incompatível é publicada em uma nova versão, e a versão com a qual você desenvolveu continua como está.
Limites de requisições
Cada resposta informa quanto da sua cota ainda resta, e uma requisição limitada informa quando tentar de novo.

Da primeira chave à entrega no ar

  1. 1

    Pegue suas chaves

    Solicite uma conta. Depois que ela for aprovada, crie uma chave de sandbox.

  2. 2

    Desenvolva no sandbox

    Crie lançamentos e faça entregas de teste até a sua integração tratar todos os estados.

  3. 3

    Solicite acesso à produção

    Conte-nos o que você está construindo. Nós analisamos e emitimos as chaves de produção.

  4. 4

    Entregue

    Troque pela chave de produção e as mesmas chamadas passam a chegar às lojas de verdade.

Perguntas sobre o Engine

Não. A referência é pública. Você só precisa de uma conta, que abrimos mediante solicitação, quando quiser uma chave.

Sim. Um lançamento criado pela API aparece no painel, e um criado no painel pode ser lido e entregue pela API.

A entrega passa pelos mesmos estados de uma entrega real e dispara os mesmos webhooks, mas nada é enviado a uma loja.

Faça sua primeira requisição no sandbox