پیش از درخواست، کل API را بخوانید
مرجع Engine آزاد است. منابع، فیلدها و خطاها با مثال مستند شدهاند و هیچکدام پشت فرم نیست. وقتی خواستید یک فراخوانی را امتحان کنید، برای حساب درخواست دهید و یک کلید sandbox بسازید.
- برای خواندن
- بدون نیاز به حساب
- قالب
- مرجع REST با نمونه
- کلیدهای sandbox
- با حساب تأییدشده
با یک درخواست شروع کنید
سریعترین راه خواندن یک API فراخوانی آن است. این چهار درخواست ساعت اول خوبی میسازند: بررسی کار کردن کلید، فهرست کردن آنچه هست، ساختن یک ریلیز و اشتراک در رویدادها.
- هر endpoint با یک درخواست و یک پاسخ نشان داده شده است
- خطاها همراه علت و راهحل فهرست شدهاند
- نمونهها همانطور که نوشته شدهاند روی sandbox اجرا میشوند
اولین درخواستها
نمونه درخواستهاGET/v1/me
پاسخ
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}مرجع، به تفکیک منبع
- ریلیزها
- ریلیزها را با مناطق و تاریخهایشان بسازید، بهروز کنید، ثبت کنید و حذف کنید.
- آهنگها و داراییها
- آهنگ اضافه کنید، صدا و آرتورک آپلود کنید و عوامل، کدها و تقسیم سهم را تعیین کنید.
- ارسالها
- یک ریلیز را به فروشگاهها بفرستید و هر مقصد را از در صف تا منتشرشده یا ردشده دنبال کنید.
- تحلیلها
- استریمها و دانلودها را به تفکیک فروشگاه، منطقه، ریلیز، آهنگ و روز بخوانید.
- رویالتی
- صورتحسابها را فهرست کنید، سطرهایشان را بخوانید و ببینید به هر ذینفع چقدر بدهکارید.
- Webhookها
- یک endpoint ثبت کنید، رویدادهایی را که دریافت میکند انتخاب کنید و آنچه فرستاده شده را مرور کنید.
شروع سریع، روی sandbox
- 1
ساخت کلید sandbox
برای حساب درخواست دهید و پس از تأیید، کلید را از آن کپی کنید.
- 2
اولین درخواست خود را بفرستید
/v1/me را با کلید در هدر Authorization فراخوانی کنید تا از کار کردن آن مطمئن شوید.
- 3
ساخت یک ریلیز آزمایشی
یک ریلیز با عنوان و هنرمند ارسال کنید، سپس یک آهنگ به آن اضافه کنید.
- 4
شبیهسازی ارسال
آن را در sandbox ارسال کنید و حرکت وضعیت را ببینید، بدون هیچ فروشگاهی.
یک هدر، و وارد شدهاید
احراز هویت یک کلید API است که بهعنوان bearer token ارسال میشود. نه دستدهیای هست و نه نشستی که زنده نگه داشتن بخواهد. این را کپی کنید، کلید خود را جایگزین کنید و اجرا کنید.
- sandbox و محیط واقعی کلیدهای جداگانه دارند
- کلید را میتوان هر زمان لغو کرد
فهرست ریلیزهای خود را بگیرید
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"