Citiți întreg API-ul înainte de a face cererea
Referința Engine este publică. Resursele, câmpurile și erorile sunt documentate cu exemple, iar nimic nu se află în spatele unui formular. Când doriți să încercați un apel, cereți un cont și creați o cheie sandbox.
- De citit
- Nu este nevoie de cont
- Format
- Referință REST cu exemple
- Chei sandbox
- Cu un cont aprobat
Începeți cu o cerere
Cea mai rapidă metodă de a citi un API este să-l apelați. Aceste patru cereri alcătuiesc o primă oră bună: verificați că cheia funcționează, listați ce există, creați o lansare și abonați-vă la evenimente.
- Fiecare endpoint este prezentat cu o cerere și un răspuns
- Erorile sunt listate cu cauza și soluția
- Exemplele rulează în sandbox exact cum sunt scrise
Primele cereri
Exemple de cereriGET/v1/me
Răspuns
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}Referința, pe resurse
- Lansări
- Creați, actualizați, trimiteți și retrageți lansări, cu teritoriile și datele lor.
- Piese și resurse
- Adăugați piese, încărcați audio și coperte și setați credite, coduri și splituri.
- Livrări
- Trimiteți o lansare către platforme și urmăriți fiecare destinație de la în coadă până la activ sau refuzat.
- Analize
- Citiți streamuri și descărcări pe platformă, teritoriu, lansare, piesă și zi.
- Redevențe
- Listați rapoartele, citiți rândurile lor și vedeți ce i se datorează fiecărui beneficiar.
- Webhook-uri
- Înregistrați un endpoint, alegeți evenimentele pe care le primește și verificați ce a fost trimis.
Ghid rapid, în sandbox
- 1
Creați o cheie sandbox
Cereți un cont și, după aprobare, copiați cheia din el.
- 2
Faceți prima cerere
Apelați /v1/me cu cheia în antetul Authorization pentru a confirma că funcționează.
- 3
Creați o lansare de test
Trimiteți o lansare cu un titlu și un artist, apoi adăugați-i o piesă.
- 4
Simulați o livrare
Livrați-o în sandbox și urmăriți cum se schimbă starea, fără nicio platformă implicată.
Un antet și sunteți înăuntru
Autentificarea este o cheie API trimisă ca bearer token. Nu există handshake și nici sesiune de menținut activă. Copiați acest exemplu, înlocuiți cheia și rulați-l.
- Sandbox-ul și producția folosesc chei separate
- O cheie poate fi revocată oricând
Listați lansările dumneavoastră
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"