بداية سريعة مع API
سيأخذك هذا الدليل من الصفر حتى أول طلب ناجح: إنشاء رمز شخصي ومعرفة العنوان الأساسي واستدعاء نقطة REST.
الخطوة 1. إنشاء رمز شخصي
افتح لوحة التحكم الشخصية، قسم الرموز الشخصية، وأنشئ رمزاً جديداً (PAT). انسخ قيمته فوراً — تُعرض مرة واحدة فقط وتبدأ بالبادئة mbp_. عند الإنشاء اختر نطاقات الوصول (scopes) الكافية لمهمتك؛ التفاصيل في دليل التفويض.
الخطوة 2. العنوان الأساسي والتنسيق
جميع نقاط REST تقع تحت البادئة /api. لا يوجد تعيين إصدار في المسار. أجسام الطلبات والاستجابات بصيغة JSON؛ مرّر ترويسة Content-Type: application/json للطلبات ذات الجسم. يُمرَّر الرمز عبر ترويسة Authorization: Bearer mbp_….
الخطوة 3. أول طلب — قائمة البوتات
تحقق من صحة الرمز بطلب قائمة بوتاتك. يتطلب ذلك نطاق bots:read (أو *):
curl -H "Authorization: Bearer mbp_رمزك" https://نطاقك/api/bots
ستأتي الاستجابة مصفوفة JSON من البوتات. إن كان الرمز غير صحيح أو منتهي الصلاحية — سيُعاد 401 بجسم {"error":"..."} (راجع الأخطاء).
الخطوة 4. أول تعديل — إنشاء تفاعل
إنشاء تفاعل يتطلب نطاق reactions:write. استبدل معرّف البوت من الخطوة 3:
curl -X POST -H "Authorization: Bearer mbp_رمزك" -H "Content-Type: application/json" -d '{"name":"مرحباً","trigger":{"type":"command","value":"/start"}}' https://نطاقك/api/bots/BOT_ID/reactions
ستُعيد الاستجابة الناجحة التفاعل المُنشأ مع id الخاص به. راجع حقول الجسم الدقيقة في المرجع التفاعلي — يُولّد أمثلة جاهزة على curl وJavaScript وPython لكل نقطة نهاية.
الخطوة 5. الاستمرار — عبر المرجع
حين يعمل الرمز، يصبح الاستكشاف أسهل في المرجع التفاعلي: تجد فيه القائمة الكاملة لنقاط النهاية، والـ scopes المطلوبة، ومخططات الأجسام وزر «Try it».
الخطوات التالية
- التفويض والرموز — تفاصيل PAT والترويسة والـ scopes.
- الأخطاء — التنسيق وأكواد الحالة.
- الترقيم — كيفية تصفح القوائم الكبيرة.