اقرأ API كاملًا قبل أن تقدّم طلبًا

مرجع Engine مفتوح. الموارد والحقول والأخطاء موثّقة بأمثلة، ولا شيء منها خلف نموذج. وعندما تريد تجربة استدعاء، قدّم طلبًا لفتح حساب وأنشئ مفتاح البيئة التجريبية.

للقراءة
لا حاجة إلى حساب
الصيغة
مرجع REST مع أمثلة
مفاتيح البيئة التجريبية
مع حساب معتمد

ابدأ بطلب

أسرع طريقة لقراءة واجهة برمجية هي استدعاؤها. تصلح هذه الطلبات الأربعة لساعتك الأولى: تحقق من أن مفتاحك يعمل، واعرض ما هو موجود، وأنشئ إصدارًا، واشترك في الأحداث.

  • يُعرض كل endpoint مع طلب واستجابة
  • تُدرج الأخطاء مع سببها وحلّها
  • تعمل الأمثلة على البيئة التجريبية كما هي مكتوبة

الطلبات الأولى

أمثلة على الطلبات

GET/v1/me

الاستجابة

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

المرجع، حسب المورد

الإصدارات
أنشئ الإصدارات وحدّثها وأرسلها وأزلها، مع أقاليمها وتواريخها.
المسارات والأصول
أضف المسارات وارفع الصوت والأغلفة، وحدّد المساهمات والرموز والحصص.
التسليمات
أرسل إصدارًا إلى المتاجر وتابع كل وجهة من قائمة الانتظار حتى الإتاحة أو الرفض.
التحليلات
اقرأ البث والتنزيلات حسب المتجر والإقليم والإصدار والمسار واليوم.
العائدات
اعرض الكشوف واقرأ سطورها واعرف ما يستحقه كل مستفيد.
Webhooks
سجّل نقطة نهاية، واختر الأحداث التي تستقبلها، وراجع ما أُرسل.

بداية سريعة على البيئة التجريبية

  1. 1

    أنشئ مفتاحًا تجريبيًا

    قدّم طلبًا لفتح حساب، وانسخ المفتاح منه بعد الموافقة عليه.

  2. 2

    أرسل طلبك الأول

    استدعِ /v1/me مع المفتاح في ترويسة Authorization للتأكد من أنه يعمل.

  3. 3

    أنشئ إصدارًا تجريبيًا

    أرسل إصدارًا بعنوان وفنان، ثم أضف إليه مسارًا.

  4. 4

    حاكِ تسليمًا

    سلّمه في البيئة التجريبية وراقب تغيّر الحالة، دون إشراك أي متجر.

ترويسة واحدة وأنت في الداخل

المصادقة مفتاح API يُرسل كرمز bearer. لا مصافحة ولا جلسة يجب إبقاؤها حية. انسخ هذا واستبدل مفتاحك به ثم شغّله.

  • تستخدم البيئة التجريبية والإنتاج مفاتيح منفصلة
  • يمكن إلغاء المفتاح في أي وقت

اعرض إصداراتك

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

أسئلة حول الوثائق

لا. المرجع متاح للعموم. ولا تحتاج إلى حساب إلا عندما تريد مفتاحًا.

نقاط النهاية والاستجابات هي نفسها. تتوقف تسليمات البيئة التجريبية قبل أي متجر، وتُحفظ بياناتها بمعزل عن كتالوجك الفعلي.

تُدوَّن الإضافات في سجل التغييرات. أما التغيير الذي يكسر التوافق فيصدر بإصدار جديد في المسار، فيبقى الإصدار الذي بنيت عليه كما هو.

اقرأ أولًا، ثم أرسل طلبًا