التوثيقAPI v1
أقسام التوثيق

المصادقة

مفاتيح Bearer وصلاحيات محدّدة وعزل لمساحات العمل.

نفّذ المصادقة على الخادم

أرسل مفتاح API في الترويسة Authorization: Bearer <key>. المفتاح ليس JWT. استدعِ موكّل من خادم موثوق، ولا تضع المفتاح في JavaScript المتصفّح أو الروابط أو أحداث التحليلات.

Authorization: Bearer <your-workspace-key>
Content-Type: application/json

امنح الصلاحيات اللازمة فقط

الصلاحيات مستقلة. مفتاح write لا يحصل تلقائيًا على read. كما يجب أن يطابق المفتاح المقيّد بوكيل الوكيلَ المعنيّ بالعملية.

Scopeالاستخدام
readقراءة الإعداد وسجلات المحادثات المسموح بها
writeإنشاء الوكلاء وتعديل الإعداد ودورة الحياة
converseإنشاء المحادثات وإرسال الرسائل

المفتاح يحدّد مساحة العمل

لا ترسل tenant أو tenant_id أو محدّدًا آخر للمستأجر. تُرفض هذه الحقول ولا تُستخدم لتبديل مساحة العمل. استخدم المفتاح المناسب لكل مساحة.

أدر دورة حياة المفتاح

احتفظ بالمفتاح بسرية عند إصداره. إذا انكشف، ألغِه من إدارة مساحة العمل واستبدله في مخزن أسرار الخادم. راجع الصلاحيات عند استجابة 403، ولا توسّعها لمجرّد تجاوز الخطأ.