واجهة برمجة تطبيقات الإدارة (Admin API)
إدارة betool بأكملها متاحة عبر واجهة REST مُصادَق عليها. هذه هي القناة المخصّصة للأتمتة: تزويد المؤسسات فوريًّا، ومزامنة pipeline من مستودع Git الخاص بك، ولوحات معلومات مخصّصة، والتكامل مع أنظمة ITSM.
المصادقة
رمز Bearer صادر من الإدارة ← الرموز (Tokens) داخل مؤسستك.
curl -H "Authorization: Bearer $BETOOL_TOKEN" \
https://platform.betool.ai/api/admin/me
الرمز محصور في مؤسسة واحدة ودور واحد. ويحدّد الدور ما يمكنك قراءته وكتابته.
التقسيم إلى صفحات والتصفية
تتّبع جميع نقاط النهاية الخاصة بالقوائم الاصطلاح نفسه:
?limit=50(القيمة الافتراضية 25، الحد الأقصى 200)?offset=0?sort=-created_at(البادئة-للترتيب التنازلي)- عوامل تصفية مخصّصة:
?status=ok&created_after=2026-05-01
تتضمّن الاستجابة ترويسة X-Total-Count للتقسيم إلى صفحات دون مؤشر.
نقاط النهاية الرئيسية
| نقطة النهاية | الوصف |
|---|---|
GET /api/admin/me | الهوية، المؤسسة الحالية، الدور |
GET /api/admin/pipelines | سرد pipelines |
POST /api/admin/pipelines | إنشاء pipeline |
PATCH /api/admin/pipelines/{id} | تحديث pipeline |
GET /api/admin/pipelines/{id}/executions | سجل التنفيذ |
GET /api/admin/billing/balance | رصيد الاعتمادات |
POST /api/admin/billing/topup | شحن يدوي |
GET /api/admin/me/content-reads | سجل تدقيق الوصول عبر المستأجرين |
تتوفّر وثائق OpenAPI الكاملة على /api/admin/openapi.json بعد المصادقة.
عدم التكرار (Idempotency)
تقبل نقاط النهاية من نوع POST ترويسة Idempotency-Key. إذا أعدت إرسال الطلب نفسه بالمفتاح نفسه، تحصل على الاستجابة نفسها — وهو أمر مفيد لاستراتيجيات إعادة المحاولة من جانب المستدعي.
webhooks الصادرة
يمكنك تهيئة betool لإشعارك عند الأحداث المهمّة (فشل تنفيذ، رصيد منخفض، مستخدم جديد). راجع webhooks الصادرة.
تحديد معدّل الطلبات
بشكل افتراضي:
- 1000 طلب / الدقيقة لكل رمز
- 100 طلب / الدقيقة لنقاط نهاية الكتابة المكلفة (إنشاء pipeline، الاستيراد الدفعي)
في خطة Enterprise، تكون الحدود قابلة للتهيئة.
حزم SDK
لا توجد حزم SDK رسمية (حتى الآن). الواجهة بسيطة بما يكفي لاستهلاكها من أي لغة تتوفّر لها عميل HTTP.
إذا كتبت حزمة SDK لمؤسستك، فأخبِرنا — وسنُدرجها.