المطورون

رموز API

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

من يمكنه استخدامه: الأدوار «المالك» و«مدير»، أو دور مخصّص يملك صلاحية «تغيير إعدادات مساحة العمل واتصالاتها». يعمل الرمز باسم الشخص الذي أنشأه، ولا يرى كل شخص ولا يُبطل إلا رموزه الخاصة.

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

1. 1

   الخطوة 1: افتح تبويب «رموز API»

   اضغط «الإعدادات» في القائمة الجانبية، ثم تبويب «رموز API». تعرض الصفحة رموزك، و«عنوان واجهة البرمجة»، وأول طلب تحت «جرّبه».

   افتح رموز API

2. 2

   الخطوة 2: سمِّ الرمز واضغط «إنشاء الرمز»

   اكتب في «اسم الرمز» اسمًا يدل على مكان استخدامه، مثل مزامنة جدول المخزون. حدد «يمكنه استخدام واجهة برمجة الذكاء الاصطناعي» فقط للبرامج التي تستدعي /api/v1/ai؛ وتُعلِّم القائمة تلك الرموز بـ«واجهة الذكاء الاصطناعي».

   

3. 3

   الخطوة 3: انسخ الرمز الآن

   يظهر الرمز الجديد مرة واحدة، مع زر «نسخ» والعبارة «انسخ رمزك الجديد الآن. لن يُعرض مرة أخرى.» احفظه في إعدادات خادمك، ولا تضعه أبدًا في صفحة ويب.

4. 4

   الخطوة 4: أجرِ أول طلب

   أرسل الرمز في ترويسة Authorization كرمز Bearer، مع Accept: application/json. الطلب الموجود تحت «جرّبه» يستدعي /api/v1/me، الذي يجيب باسمك وبريدك الإلكتروني ودورك، واسم مساحة العمل وباقتها.

   curl https://magiz.ai/api/v1/me \
     -H "Authorization: Bearer $MAGIZAI_TOKEN" \
     -H "Accept: application/json"

   

5. 5

   الخطوة 5: اقرأ توثيق واجهة البرمجة

   اضغط «اقرأ توثيق واجهة البرمجة» لفتح المرجع العام في /api-docs. بهذا الرمز يمكنك عرض روبوتات الدردشة ومحادثاتها، وقراءة محادثة، وإضافة معرفة أو إزالتها، وإرسال رسالة زائر لتتلقى رد الذكاء الاصطناعي.

   واجهتا البوابة والموظفين في الصفحة نفسها تستخدمان رموزًا من نقاط تسجيل الدخول الخاصة بهما: الرمز المأخوذ من هذه الشاشة يتلقى 403 هناك.

6. 6

   الخطوة 6: أبطل رمزًا لم تعد تستخدمه

   اضغط «إبطال» بجانبه وأكّد. يتوقف أي برنامج يستخدمه عن العمل فورًا.

هل توقفت عند خطوة؟ اسأل فريقنا