Lees de hele API voordat u aanvraagt

De Engine-referentie is openbaar. Resources, velden en fouten zijn gedocumenteerd met voorbeelden, en niets zit achter een formulier. Wilt u een aanroep proberen, vraag dan een account aan en maak een sandbox-sleutel aan.

Om te lezen
Geen account nodig
Formaat
REST-referentie met voorbeelden
Sandboxsleutels
Met een goedgekeurd account

Begin met een verzoek

De snelste manier om een API te leren kennen is hem aanroepen. Deze vier verzoeken vormen een goed eerste uur: controleer of uw sleutel werkt, vraag op wat er is, maak een release aan en abonneer u op gebeurtenissen.

  • Elk endpoint wordt getoond met een verzoek en een antwoord
  • Fouten worden vermeld met hun oorzaak en de oplossing
  • Voorbeelden werken in de sandbox zoals ze er staan

Eerste verzoeken

Voorbeeldverzoeken

GET/v1/me

Response

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

De referentie, per resource

Releases
Maak releases aan, werk ze bij, dien ze in en verwijder ze, met hun territoria en datums.
Tracks en bestanden
Voeg tracks toe, upload audio en artwork en stel credits, codes en splits in.
Leveringen
Stuur een release naar stores en volg elke bestemming van in de wachtrij tot live of geweigerd.
Analyse
Lees streams en downloads per store, territorium, release, track en dag.
Royalty's
Vraag afrekeningen op, lees hun regels en zie wat elke begunstigde krijgt.
Webhooks
Registreer een endpoint, kies de gebeurtenissen die het ontvangt en bekijk wat er is verstuurd.

Snelstart, tegen de sandbox

  1. 1

    Een sandboxsleutel aanmaken

    Vraag een account aan en kopieer de sleutel eruit zodra het is goedgekeurd.

  2. 2

    Doe uw eerste verzoek

    Roep /v1/me aan met de sleutel in de Authorization-header om te bevestigen dat het werkt.

  3. 3

    Een testrelease aanmaken

    Post een release met een titel en een artiest en voeg er dan een track aan toe.

  4. 4

    Een levering simuleren

    Lever hem in de sandbox en zie de status veranderen, zonder dat er een store bij komt kijken.

Eén header en u bent binnen

Authenticatie is een API-sleutel die als bearer-token wordt verstuurd. Er is geen handshake en geen sessie om in leven te houden. Kopieer dit, vervang de sleutel door de uwe en voer het uit.

  • Sandbox en productie gebruiken aparte sleutels
  • Een sleutel kan op elk moment worden ingetrokken

Uw releases opvragen

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

Vragen over de documentatie

Nee. De naslag is openbaar. U hebt alleen een account nodig als u een sleutel wilt.

De endpoints en antwoorden zijn hetzelfde. Sandboxleveringen stoppen vóór elke store en sandboxdata wordt gescheiden gehouden van uw live catalogus.

Toevoegingen worden in de changelog vermeld. Een wijziging die iets breekt verschijnt onder een nieuwe versie in het pad, zodat de versie waarop u hebt gebouwd ongewijzigd blijft.

Eerst lezen, dan een verzoek doen