Les hele API-et før du søker
Referansen for Engine er åpen. Ressurser, felt og feil er dokumentert med eksempler, og ingenting av det ligger bak et skjema. Når du vil prøve et kall, søker du om en konto og oppretter en sandkassenøkkel.
- For å lese
- Ingen konto nødvendig
- Format
- REST-referanse med eksempler
- Sandkassenøkler
- Med en godkjent konto
Start med en forespørsel
Den raskeste måten å lese et API på er å kalle det. Disse fire forespørslene er en god første time: sjekk at nøkkelen fungerer, list opp det som finnes, opprett en utgivelse og abonner på hendelser.
- Hvert endepunkt vises med en forespørsel og et svar
- Feil er oppført med årsak og rettelse
- Eksemplene kjører mot sandkassen slik de står
Første forespørsler
EksempelforespørslerGET/v1/me
Svar
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}Referansen, per ressurs
- Utgivelser
- Opprett, oppdater, send inn og fjern utgivelser, med territorier og datoer.
- Spor og filer
- Legg til spor, last opp lyd og coverbilder, og angi kreditteringer, koder og splitter.
- Leveringer
- Send en utgivelse til butikker og følg hver mottaker fra i kø til live eller avvist.
- Analyse
- Les strømmer og nedlastinger per butikk, territorium, utgivelse, spor og dag.
- Royalty
- List oppgjør, les linjene deres og se hva hver mottaker har til gode.
- Webhooks
- Registrer et endepunkt, velg hvilke hendelser det mottar, og gå gjennom det som er sendt.
Hurtigstart, mot sandkassen
- 1
Opprett en sandkassenøkkel
Søk om en konto, og kopier nøkkelen fra den når den er godkjent.
- 2
Send din første forespørsel
Kall /v1/me med nøkkelen i Authorization-headeren for å bekrefte at den fungerer.
- 3
Opprett en testutgivelse
Post en utgivelse med tittel og artist, og legg deretter til et spor.
- 4
Simuler en levering
Lever den i sandkassen og se statusen endre seg, uten at noen butikk er involvert.
Én header, og du er inne
Autentisering skjer med en API-nøkkel sendt som bearer-token. Det er ingen handshake og ingen økt som må holdes i live. Kopier dette, bytt inn nøkkelen din og kjør det.
- Sandkasse og produksjon bruker separate nøkler
- En nøkkel kan tilbakekalles når som helst
List utgivelsene dine
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"