Lue koko API ennen hakemista

Enginen viite on avoin. Resurssit, kentät ja virheet on dokumentoitu esimerkkeineen, eikä mikään niistä ole lomakkeen takana. Kun haluat kokeilla kutsua, hae tiliä ja luo hiekkalaatikkoavain.

Luettavaksi
Tiliä ei tarvita
Muoto
REST-referenssi esimerkkeineen
Hiekkalaatikkoavaimet
Hyväksytyllä tilillä

Aloita pyynnöllä

Nopein tapa tutustua API:in on kutsua sitä. Nämä neljä pyyntöä ovat hyvä ensimmäinen tunti: tarkista, että avaimesi toimii, listaa mitä on olemassa, luo julkaisu ja tilaa tapahtumat.

  • Jokainen päätepiste näytetään pyynnön ja vastauksen kanssa
  • Virheet on listattu syineen ja korjausohjeineen
  • Esimerkit toimivat hiekkalaatikkoa vasten sellaisinaan

Ensimmäiset pyynnöt

Esimerkkipyynnöt

GET/v1/me

Vastaus

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

Referenssi resursseittain

Julkaisut
Luo, päivitä, lähetä ja poista julkaisuja alueineen ja päivämäärineen.
Kappaleet ja tiedostot
Lisää kappaleita, lataa ääni ja kansikuvat ja aseta tekijätiedot, koodit ja jako-osuudet.
Toimitukset
Lähetä julkaisu palveluihin ja seuraa jokaista kohdetta jonosta julkaistuksi tai hylätyksi.
Analytiikka
Lue suoratoistot ja lataukset palvelun, alueen, julkaisun, kappaleen ja päivän mukaan.
Rojaltit
Listaa tilitykset, lue niiden rivit ja katso, paljonko kullekin saajalle kuuluu.
Webhookit
Rekisteröi päätepiste, valitse sen vastaanottamat tapahtumat ja tarkista, mitä on lähetetty.

Pikaopas hiekkalaatikkoa vasten

  1. 1

    Luo hiekkalaatikkoavain

    Hae tiliä ja kopioi avain siltä, kun se on hyväksytty.

  2. 2

    Tee ensimmäinen pyyntösi

    Kutsu /v1/me avaimen kanssa Authorization-otsakkeessa varmistaaksesi, että se toimii.

  3. 3

    Luo testijulkaisu

    Lähetä julkaisu nimellä ja artistilla ja lisää siihen sitten kappale.

  4. 4

    Simuloi toimitus

    Toimita se hiekkalaatikossa ja seuraa tilan muuttumista ilman palveluja.

Yksi otsake, ja olet sisässä

Tunnistautuminen tapahtuu API-avaimella, joka lähetetään bearer-tokenina. Kättelyä ei ole, eikä istuntoa tarvitse pitää hengissä. Kopioi tämä, vaihda avaimesi tilalle ja aja.

  • Hiekkalaatikko ja tuotanto käyttävät erillisiä avaimia
  • Avaimen voi peruuttaa milloin tahansa

Listaa julkaisusi

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

Kysymyksiä dokumentaatiosta

Et. Referenssi on julkinen. Tili tarvitaan vain, kun haluat avaimen.

Päätepisteet ja vastaukset ovat samat. Hiekkalaatikon toimitukset pysähtyvät ennen yhtäkään palvelua, ja hiekkalaatikon data pidetään erillään live-katalogistasi.

Lisäykset merkitään muutoslokiin. Taaksepäin yhteensopimaton muutos julkaistaan uuden version alla polussa, joten versio, jota vasten rakensit, pysyy ennallaan.

Lue ensin, tee sitten pyyntö