Baca seluruh API sebelum Anda mengajukan

Referensi Engine terbuka. Resource, field, dan error didokumentasikan dengan contoh, dan tidak ada yang berada di balik formulir. Saat Anda ingin mencoba sebuah panggilan, ajukan akun dan buat kunci sandbox.

Untuk dibaca
Tanpa akun
Format
Referensi REST dengan contoh
Kunci sandbox
Dengan akun yang disetujui

Mulai dengan sebuah permintaan

Cara tercepat memahami sebuah API adalah memanggilnya. Empat permintaan ini cocok untuk jam pertama: pastikan kunci Anda berfungsi, daftar apa yang ada, buat rilis, dan berlangganan event.

  • Setiap endpoint ditampilkan dengan permintaan dan respons
  • Kesalahan didaftar beserta penyebab dan solusinya
  • Contoh berjalan di sandbox apa adanya

Permintaan pertama

Contoh permintaan

GET/v1/me

Respons

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

Referensi, per sumber daya

Rilis
Buat, perbarui, kirimkan, dan turunkan rilis, lengkap dengan wilayah dan tanggalnya.
Lagu dan aset
Tambahkan lagu, unggah audio dan artwork, serta atur kredit, kode, dan split.
Pengiriman
Kirim rilis ke toko dan pantau setiap tujuan dari antre hingga tayang atau ditolak.
Analitik
Baca stream dan unduhan per toko, wilayah, rilis, lagu, dan hari.
Royalti
Daftar laporan, baca barisnya, dan lihat berapa yang terutang kepada tiap penerima pembayaran.
Webhook
Daftarkan sebuah endpoint, pilih event yang diterimanya, dan tinjau apa yang telah dikirim.

Panduan cepat, dengan sandbox

  1. 1

    Buat kunci sandbox

    Ajukan akun, lalu salin kunci dari akun itu setelah disetujui.

  2. 2

    Buat permintaan pertama Anda

    Panggil /v1/me dengan kunci di header Authorization untuk memastikannya berfungsi.

  3. 3

    Buat rilis uji

    Kirim rilis dengan judul dan artis, lalu tambahkan sebuah lagu ke dalamnya.

  4. 4

    Simulasikan pengiriman

    Kirim di sandbox dan lihat statusnya bergerak, tanpa melibatkan toko.

Satu header, dan Anda masuk

Autentikasi menggunakan kunci API yang dikirim sebagai bearer token. Tidak ada handshake dan tidak ada sesi yang harus dijaga. Salin ini, ganti dengan kunci Anda, dan jalankan.

  • Sandbox dan produksi menggunakan kunci terpisah
  • Kunci dapat dicabut kapan saja

Daftar rilis Anda

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

Pertanyaan seputar dokumentasi

Tidak. Referensinya terbuka untuk umum. Anda hanya perlu akun jika ingin mendapatkan kunci.

Endpoint dan responsnya sama. Pengiriman sandbox berhenti sebelum sampai ke toko mana pun, dan data sandbox dipisahkan dari katalog langsung Anda.

Penambahan dicatat di changelog. Perubahan yang merusak dirilis dengan versi baru di path, sehingga versi yang Anda gunakan tetap seperti semula.

Baca dulu, lalu buat permintaan