Läs hela API:et innan du ansöker
Referensen för Engine är öppen. Resurser, fält och fel är dokumenterade med exempel, och inget av det ligger bakom ett formulär. När du vill prova ett anrop ansöker du om ett konto och skapar en sandbox-nyckel.
- Att läsa
- Inget konto behövs
- Format
- REST-referens med exempel
- Sandbox-nycklar
- Med ett godkänt konto
Börja med en förfrågan
Det snabbaste sättet att läsa ett API är att anropa det. De här fyra förfrågningarna är en bra första timme: kontrollera att din nyckel fungerar, lista vad som finns, skapa en release och prenumerera på händelser.
- Varje endpoint visas med en förfrågan och ett svar
- Fel listas med orsak och lösning
- Exemplen körs mot sandboxen precis som de står
Första förfrågningarna
ExempelanropGET/v1/me
Svar
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}Referensen, per resurs
- Releaser
- Skapa, uppdatera, skicka in och ta bort releaser, med deras territorier och datum.
- Låtar och filer
- Lägg till låtar, ladda upp ljud och omslagsbild, och ange krediter, koder och splits.
- Leveranser
- Skicka en release till butiker och följ varje mottagare från i kö till live eller avvisad.
- Analys
- Läs streams och nedladdningar per butik, territorium, release, låt och dag.
- Royalty
- Lista redovisningar, läs deras rader och se vad varje betalningsmottagare har att få.
- Webhooks
- Registrera en endpoint, välj vilka händelser den tar emot och granska vad som skickats.
Snabbstart, mot sandboxen
- 1
Skapa en sandbox-nyckel
Ansök om ett konto och kopiera nyckeln från det när det har godkänts.
- 2
Gör din första förfrågan
Anropa /v1/me med nyckeln i Authorization-huvudet för att bekräfta att den fungerar.
- 3
Skapa en testrelease
Skicka en release med en titel och en artist och lägg sedan till en låt i den.
- 4
Simulera en leverans
Leverera den i sandboxen och se hur statusen ändras, utan att någon butik är inblandad.
Ett huvud, och du är inne
Autentisering sker med en API-nyckel som skickas som bearer-token. Det finns ingen handskakning och ingen session att hålla vid liv. Kopiera det här, byt in din nyckel och kör.
- Sandbox och produktion använder separata nycklar
- En nyckel kan återkallas när som helst
Lista dina releaser
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"