Læs hele API'et, før du ansøger

Referencen til Engine er åben. Ressourcer, felter og fejl er dokumenteret med eksempler, og intet af det ligger bag en formular. Når du vil prøve et kald, ansøger du om en konto og opretter en sandbox-nøgle.

At læse
Ingen konto nødvendig
Format
REST-reference med eksempler
Sandbox-nøgler
Med en godkendt konto

Start med en forespørgsel

Den hurtigste måde at læse et API på er at kalde det. Disse fire forespørgsler er en god første time: kontrollér, at din nøgle virker, list, hvad der findes, opret en udgivelse og abonner på hændelser.

  • Hvert endpoint vises med en forespørgsel og et svar
  • Fejl er listet med årsag og løsning
  • Eksemplerne kører mod sandboxen, præcis som de står

Første forespørgsler

Eksempler på forespørgsler

GET/v1/me

Svar

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

Referencen, pr. ressource

Udgivelser
Opret, opdater, indsend og fjern udgivelser, med deres territorier og datoer.
Numre og filer
Tilføj numre, upload lyd og cover, og angiv krediteringer, koder og splits.
Leveringer
Send en udgivelse til butikker, og følg hver modtager fra i kø til live eller afvist.
Analyse
Læs streams og downloads pr. butik, territorium, udgivelse, nummer og dag.
Royalties
List opgørelser, læs deres linjer, og se, hvad hver betalingsmodtager har til gode.
Webhooks
Registrer et endpoint, vælg, hvilke hændelser det modtager, og gennemgå, hvad der blev sendt.

Hurtig start, mod sandboxen

  1. 1

    Opret en sandbox-nøgle

    Ansøg om en konto, og kopier nøglen fra den, når den er godkendt.

  2. 2

    Send din første forespørgsel

    Kald /v1/me med nøglen i Authorization-headeren for at bekræfte, at den virker.

  3. 3

    Opret en testudgivelse

    Send en udgivelse med en titel og en kunstner, og tilføj derefter et nummer til den.

  4. 4

    Simulér en levering

    Lever den i sandboxen, og se statussen bevæge sig, uden at en butik er involveret.

Én header, og du er inde

Autentificering sker med en API-nøgle sendt som bearer-token. Der er ingen handshake og ingen session at holde i live. Kopiér det her, byt din nøgle ind, og kør det.

  • Sandbox og produktion bruger separate nøgler
  • En nøgle kan tilbagekaldes når som helst

List dine udgivelser

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

Spørgsmål om dokumentationen

Nej. Referencen er offentlig. Du skal kun bruge en konto, når du vil have en nøgle.

Endpoints og svar er de samme. Leveringer i sandboxen stopper, før de når en butik, og sandbox-data holdes adskilt fra dit live katalog.

Tilføjelser noteres i ændringsloggen. En ændring, der bryder bagudkompatibilitet, udkommer under en ny version i stien, så den version, du har bygget imod, forbliver, som den er.

Læs først, send derefter en forespørgsel