Baca keseluruhan API sebelum anda memohon

Rujukan Engine adalah terbuka. Sumber, medan dan ralat didokumenkan dengan contoh, dan tiada satu pun berada di sebalik borang. Apabila anda mahu mencuba satu panggilan, mohon akaun dan cipta kunci sandbox.

Untuk dibaca
Tiada akaun diperlukan
Format
Rujukan REST dengan contoh
Kunci sandbox
Dengan akaun yang diluluskan

Mulakan dengan satu permintaan

Cara terpantas untuk membaca API ialah memanggilnya. Empat permintaan ini menjadikan satu jam pertama yang baik: semak kunci anda berfungsi, senaraikan apa yang ada, cipta keluaran dan langgan peristiwa.

  • Setiap endpoint ditunjukkan dengan permintaan dan respons
  • Ralat disenaraikan dengan punca dan pembetulannya
  • Contoh berjalan pada sandbox seperti yang ditulis

Permintaan pertama

Contoh permintaan

GET/v1/me

Respons

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

Rujukan, mengikut sumber

Keluaran
Cipta, kemas kini, hantar dan turunkan keluaran, dengan wilayah dan tarikhnya.
Trek dan aset
Tambah trek, muat naik audio dan karya seni, dan tetapkan kredit, kod dan pecahan.
Penghantaran
Hantar keluaran ke kedai dan ikuti setiap destinasi daripada dalam baris gilir hingga aktif atau ditolak.
Analitik
Baca strim dan muat turun mengikut kedai, wilayah, keluaran, trek dan hari.
Royalti
Senaraikan penyata, baca barisnya dan lihat apa yang terhutang kepada setiap penerima bayaran.
Webhook
Daftarkan endpoint, pilih peristiwa yang diterimanya dan semak apa yang telah dihantar.

Mula pantas, menggunakan sandbox

  1. 1

    Cipta kunci sandbox

    Mohon akaun, dan salin kunci daripadanya setelah diluluskan.

  2. 2

    Buat permintaan pertama anda

    Panggil /v1/me dengan kunci dalam pengepala Authorization untuk mengesahkan ia berfungsi.

  3. 3

    Cipta keluaran ujian

    Hantar keluaran dengan tajuk dan artis, kemudian tambah trek padanya.

  4. 4

    Simulasikan penghantaran

    Hantar dalam sandbox dan lihat status bergerak, tanpa melibatkan kedai.

Satu pengepala, dan anda masuk

Pengesahan ialah kunci API yang dihantar sebagai token bearer. Tiada jabat tangan dan tiada sesi untuk dikekalkan. Salin ini, gantikan dengan kunci anda dan jalankan.

  • Sandbox dan pengeluaran menggunakan kunci berasingan
  • Kunci boleh dibatalkan pada bila-bila masa

Senaraikan keluaran anda

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

Soalan tentang dokumen

Tidak. Rujukan itu terbuka kepada umum. Anda hanya memerlukan akaun apabila mahukan kunci.

Endpoint dan responsnya sama. Penghantaran sandbox berhenti sebelum sampai ke mana-mana kedai, dan data sandbox diasingkan daripada katalog langsung anda.

Penambahan dicatatkan dalam log perubahan. Perubahan yang memecahkan keserasian dikeluarkan di bawah versi baharu dalam laluan, jadi versi yang anda bina tetap seperti sedia ada.

Baca dahulu, kemudian buat permintaan