مفاتيح API والنطاقات
يتيح مفتاح API لنص برمجي أو نظام آخر استدعاء واجهة xEvolve دون تسجيل الدخول إلى لوحة التحكم. يحمل كل مفتاح نطاقات تحدّ مما يستطيع فعله.
إنشاء مفتاح
- افتح مفاتيح API واختر مفتاح جديد.
- أدخل اسماً، وحدّد النطاقات المطلوبة، واضبط اختيارياً مدة انتهاء بالأيام.
- انسخ المفتاح. يبدأ بـ
xev_ويظهر مرة واحدة فقط. يحتفظ xEvolve بالبصمة (hash) فقط.
أرسل المفتاح كرمز bearer إلى مساحة عملك:
curl https://<workspace>.xevolve.io/api/v1/connections \
-H "Authorization: Bearer xev_<key>"يسري إلغاء المفتاح فوراً. يُكتب إنشاء المفاتيح وإلغاؤها في سجل التدقيق.
القواعد
- لا يمكن لمفتاح إنشاء مفاتيح إلا بنطاقات ضمن نطاقاته. طلب المزيد يُرجع 403.
- الاستدعاء الذي يفتقر إلى النطاق المطلوب يُرجع 403 مع
API key missing required scope. - جلسة لوحة التحكم غير مقيّدة بالنطاقات؛ فهي تتبع دور المستخدم.
- إعدادات المصادقة متعددة العوامل وإدارة الجلسات وأحداث تسجيل الدخول وتسجيل service principals والصور الرمزية وسياسة الاحتفاظ وحالة التجربة لا تقبل إلا جلسات لوحة التحكم. تتلقى مفاتيح API الرمز 403.
النطاقات
| النطاق | يسمح بـ |
|---|---|
files:read | عرض الملفات والبحث فيها وتنزيلها. |
files:write | رفع الملفات. |
transfers:read | عرض عمليات النقل والاطلاع عليها. |
transfers:write | إنشاء عمليات النقل وتشغيلها وإلغاؤها. |
connections:read | عرض الاتصالات والاطلاع عليها. |
connections:write | إنشاء الاتصالات وتعديلها وحذفها واختبارها. |
data-rooms:read | عرض غرف البيانات والاطلاع عليها. |
data-rooms:write | إنشاء غرف البيانات وتعديلها وإدارتها. |
schedules:read | عرض الجداول الزمنية وسجل التشغيل. |
schedules:write | إنشاء الجداول الزمنية وتعديلها وحذفها وتشغيلها. |
watchers:read | عرض مراقبات المجلدات. |
watchers:write | إنشاء المراقبات وتعديلها وحذفها. |
workflows:read | عرض سير العمل وسجل التشغيل. |
workflows:write | إنشاء سير العمل وتعديله وحذفه وتشغيله. |
parameters:read | عرض المعاملات العامة والاطلاع عليها. |
parameters:write | إنشاء المعاملات العامة وتعديلها وحذفها. |
users:read | عرض المستخدمين والاطلاع عليهم. |
users:write | تعديل المستخدمين وحذفهم. |
agents:read | عرض الوكلاء المُدارين والاطلاع عليهم. |
agents:write | إنشاء الوكلاء المُدارين وتعديلهم وحذفهم واختبارهم. |
webhooks:read | عرض الـ webhooks وعمليات التسليم. |
webhooks:write | إنشاء الـ webhooks وتعديلها وحذفها. |
activity:read | قراءة سجل النشاط وعدادات لوحة المعلومات. |
notifications:read | قراءة إعدادات الإشعارات وسجل الإشعارات. |
notifications:write | تعديل إعدادات الإشعارات أو اختبارها. |
api-keys:read | عرض مفاتيح API. |
api-keys:write | إنشاء مفاتيح API وإلغاؤها، ضمن النطاقات التي يملكها المفتاح المستدعي. |
تتطلب مفاتيح API والـ webhooks خطة Team أو أعلى. تذكر الخطط والحدود طلبات API المسموح بها شهرياً.