تعتمد واجهة الإدارة على الويب في betool على واجهة REST مُصادَق عليها (البادئة /api)، يمكن استخدامها أيضًا من سكربتاتك: لوحات معلومات مخصّصة للاستهلاك، وتصدير السجلّات، ومتابعة رصيد الاعتمادات.
المصادقة
يحمل كل استدعاء رمز جلسة في Authorization: Bearer. وللاستخدام الآلي، أنشئ رمز CLI طويل الأمد من قائمة المؤسسة ← « Paramètres de l'organisation » ← رموز واجهة سطر الأوامر (لا تُعرَض قيمته الصريحة إلا مرة واحدة، قابل للإلغاء في أي وقت، ومُجزَّأ (hashed) على جانب الخادم)، ثم استبدله برمز جلسة:
# 1. استبدال رمز CLI بجلسة (معدّل محدود: 10/دقيقة)
curl -X POST https://platform.betool.ai/api/auth/cli-login \
-H "Content-Type: application/json" \
-d "{\"token\": \"$BETOOL_CLI_TOKEN\"}"
# -> {"session_token": "...", "user": {...}, "active_org": {...}, ...}
# 2. استدعاء الواجهة بالجلسة
curl -H "Authorization: Bearer $BETOOL_SESSION" \
https://platform.betool.ai/api/auth/me
رمز CLI مُثبَّت على مؤسسة واحدة؛ ويتوقّف عن العمل إذا عُطِّل حامله أو لم يعد عضوًا نشطًا في هذه المؤسسة. وتتبع الصلاحيات عضويته.
التصفية
تقبل نقاط النهاية الخاصة بالقوائم معاملات خاصة بكل مورد (عادةً limit محدود على جانب الخادم)؛ والحقول المتاحة موثَّقة في الاستجابة نفسها.
نقاط النهاية الرئيسية
| نقطة النهاية | الوصف |
|---|---|
GET /api/auth/me | الهوية، المؤسسة النشطة، العضويات |
GET /api/admin/models | سرد النماذج (pipelines) |
GET /api/admin/llm/accounts | سرد حسابات LLM (السرّ مُقنَّع، has_api_key) |
GET /api/admin/billing/state | الخطة، رصيد الاعتمادات، الشحن التلقائي |
POST /api/admin/billing/topup | شحن يدوي (رابط دفع) |
GET /api/admin/billing/usage | سجلّ الاستهلاك (limit ≤ 500، مرشِّح source_kind) |
GET /api/admin/me/supervisor-reads | سجلّ تدقيق الوصول العابر للمستأجرين |
لقيادة التهيئة باللغة الطبيعية (إنشاء/تحرير pipeline عبر مقترحات، لا تُطبَّق إلا بعد قبولها)، فضِّل خادم MCP: فهو الواجهة المصمَّمة للعملاء الخارجيين.
webhooks الصادرة
تحتاج إلى دفع أحداث نحو أنظمتك؟ أطلِقها من الـpipelines الخاصة بك بالعقدة webhook_action — راجع webhooks الصادرة.
تحديد معدّل الطلبات
نقاط نهاية المصادقة (التسجيل، تسجيل الدخول، إعادة التعيين) خاضعة لتحديد المعدّل. أما نقاط النهاية الأخرى فلا حصّة منشورة لها حتى اليوم — ويجب أن يبقى الاستخدام الآلي المكثّف معقولًا.
حزم SDK
لا توجد حزمة SDK رسمية. الواجهة بسيطة بما يكفي لاستهلاكها من أي لغة عبر عميل HTTP.
إذا كتبت حزمة SDK لمؤسستك، فأخبِرنا — وسنُشير إليها.