Olvassa el a teljes API-t a jelentkezés előtt

Az Engine referenciája nyilvános. Az erőforrások, mezők és hibák példákkal vannak dokumentálva, és semmi sincs űrlap mögött. Ha ki szeretne próbálni egy hívást, jelentkezzen fiókra, és hozzon létre egy sandbox-kulcsot.

Olvasásra
Fiók nem szükséges
Formátum
REST-referencia példákkal
Sandbox-kulcsok
Jóváhagyott fiókkal

Kezdje egy kéréssel

Egy API megismerésének leggyorsabb módja, ha meghívja. Ez a négy kérés jó első órát ad: ellenőrizze, hogy a kulcsa működik-e, listázza, mi van ott, hozzon létre egy kiadványt, és iratkozzon fel az eseményekre.

  • Minden végpont kéréssel és válasszal van bemutatva
  • A hibák okukkal és javításukkal vannak felsorolva
  • A példák a sandboxban úgy futnak, ahogy le vannak írva

Első kérések

Példakérések

GET/v1/me

Válasz

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

A referencia erőforrásonként

Kiadványok
Hozzon létre, frissítsen, küldjön be és távolítson el kiadványokat, a területeikkel és dátumaikkal együtt.
Számok és fájlok
Adjon hozzá számokat, töltsön fel hangot és borítóképet, és állítsa be a közreműködőket, a kódokat és a megosztásokat.
Kézbesítések
Küldjön ki egy kiadványt az áruházakba, és kövesse az egyes célállomásokat a sorban állástól az éles állapotig vagy az elutasításig.
Analitika
Olvassa a streameket és a letöltéseket áruház, terület, kiadvány, szám és nap szerint.
Jogdíjak
Listázza az elszámolásokat, olvassa a soraikat, és nézze meg, mennyivel tartozik az egyes kedvezményezetteknek.
Webhookok
Regisztráljon egy végpontot, válassza ki a fogadott eseményeket, és tekintse át, mi lett elküldve.

Gyorsindítás, a sandboxban

  1. 1

    Sandbox-kulcs létrehozása

    Jelentkezzen fiókra, és a jóváhagyás után másolja ki belőle a kulcsot.

  2. 2

    Küldje el az első kérését

    Hívja a /v1/me végpontot az Authorization fejlécben lévő kulccsal, hogy megerősítse, működik.

  3. 3

    Tesztkiadvány létrehozása

    Küldjön be egy kiadványt címmel és előadóval, majd adjon hozzá egy számot.

  4. 4

    Kézbesítés szimulálása

    Kézbesítse a sandboxban, és figyelje az állapot változását, áruház bevonása nélkül.

Egy fejléc, és bent van

A hitelesítés egy bearer tokenként küldött API-kulcs. Nincs kézfogás, és nincs fenntartandó munkamenet. Másolja ki, cserélje be a kulcsát, és futtassa.

  • A sandbox és az éles környezet külön kulcsot használ
  • A kulcs bármikor visszavonható

Listázza a kiadványait

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

Kérdések a dokumentációról

Nem. A referencia nyilvános. Csak akkor kell fiók, ha kulcsot szeretne.

A végpontok és a válaszok megegyeznek. A sandbox-kézbesítések bármelyik áruház előtt megállnak, a sandbox-adatokat pedig elkülönítjük az élő katalógusától.

A kiegészítéseket a változásnaplóban jelezzük. A visszafelé nem kompatibilis változás új verzió alatt jelenik meg az útvonalban, így az a verzió, amelyre épített, változatlan marad.

Előbb olvasson, aztán küldjön kérést