توزیع را از داخل محصول خودتان اجرا کنید

Engine همان API پلتفرم Aevora است. از داخل محصولی که مشتریانتان همین حالا استفاده می‌کنند، روی REST ریلیز بسازید، به فروشگاه‌ها ارسال کنید، تحلیل‌ها را بخوانید و رویالتی را محاسبه کنید. مستندات عمومی است و یک محیط sandbox برای ساخت و آزمایش در اختیارتان است.

رابط
REST و JSON
احراز هویت
کلیدهای API، یک مجموعه برای هر محیط
sandbox
ارسال آزمایشی، بدون درگیر شدن فروشگاه‌ها

چهار فراخوانی یک ریلیز را از پیش‌نویس تا صورت‌حساب می‌رسانند

API همان مسیری را دنبال می‌کند که ریلیز در داشبورد می‌پیماید: بسازید، ارسال کنید، ارقام را همان‌طور که می‌رسند بخوانید، سپس صورت‌حساب را بخوانید. یک فراخوانی را انتخاب کنید تا ببینید چه می‌فرستید و چه برمی‌گردد.

  • درخواست‌ها و پاسخ‌ها JSON هستند
  • خطا نام فیلد ناموفق و دلیل آن را می‌گوید
  • همان فراخوانی‌ها هم در sandbox و هم در محیط واقعی کار می‌کنند

API مربوط به Engine

نمونه درخواست‌ها

POST/v1/releases

بدنه درخواست

{  "title": "Night Drive",  "artist": "Mira Kaya",  "label": "Northfield Audio",  "release_date": "2027-03-12"}

پاسخ

{  "id": "rel_8f2k1",  "status": "draft",  "upc": null}

آنچه دور و بر endpointها قرار دارد

فراخوانی‌ها بخش کوتاه یک یکپارچه‌سازی‌اند. این‌ها بخش‌هایی است که وقتی کسی نگاه نمی‌کند هم کار را سرپا نگه می‌دارد.

Webhookها
وقتی وضعیت یک ارسال تغییر می‌کند، ریلیزی منتشر می‌شود یا صورت‌حسابی آماده است، یک رویداد دریافت کنید تا لازم نباشد مدام پرس‌وجو کنید.
کلیدهای idempotency
با درخواست نوشتن یک کلید بفرستید تا تلاش مجدد، به‌جای ساختن ریلیز دوم، نتیجه اول را برگرداند.
صفحه‌بندی
فهرست‌ها یک cursor برمی‌گردانند. آن را پس بفرستید تا صفحه بعد را با همان ترتیب همیشگی بگیرید.
sandbox
یک محیط جداگانه با کلیدهای خودش. ارسال‌ها از ابتدا تا انتها اجرا می‌شوند و پیش از رسیدن به هر فروشگاه متوقف می‌شوند.
نسخه‌بندی
نسخه بخشی از مسیر است. تغییر ناسازگار با نسخه جدید عرضه می‌شود، پس نسخه‌ای که بر پایه‌اش ساخته‌اید همان‌طور که هست می‌ماند.
محدودیت نرخ
هر پاسخ می‌گوید چه مقدار از سهمیه شما باقی است، و درخواست محدودشده می‌گوید چه زمانی دوباره امتحان کنید.

از اولین کلید تا ارسال واقعی

  1. 1

    کلیدهایتان را بگیرید

    برای حساب درخواست دهید. پس از تأیید، یک کلید sandbox بسازید.

  2. 2

    روی sandbox بسازید

    ریلیز بسازید و ارسال آزمایشی اجرا کنید تا یکپارچه‌سازی شما همه حالت‌ها را مدیریت کند.

  3. 3

    درخواست دسترسی به محیط واقعی

    بگویید چه می‌سازید. ما بررسی می‌کنیم و کلیدهای محیط واقعی را صادر می‌کنیم.

  4. 4

    ارسال

    به کلید محیط واقعی تغییر دهید تا همان فراخوانی‌ها به فروشگاه‌های واقعی برسند.

پرسش‌هایی درباره Engine

خیر. مرجع عمومی است. فقط وقتی کلید می‌خواهید به حساب نیاز دارید که آن را با درخواست باز می‌کنیم.

بله. ریلیزی که از طریق API ساخته شود در داشبورد دیده می‌شود، و ریلیزی که در داشبورد ساخته شده از طریق API قابل خواندن و ارسال است.

ارسال از همان وضعیت‌های ارسال واقعی عبور می‌کند و همان webhookها را می‌فرستد، اما چیزی به هیچ فروشگاهی ارسال نمی‌شود.

اولین درخواست خود را در sandbox بفرستید