إنتقل إلى المحتوى الرئيسي

رموز الوصول

توفّر رموز الوصول (API Tokens) وصولاً برمجياً لواجهة برمجة Orki. تتيح للأنظمة الخارجية التفاعل مع مؤسستك بدون الحاجة لمستخدم بشري — مثالية للتكاملات، والأتمتة، ومسارات العمل المخصصة.

المسار: الإعدادات > رموز الوصول

إنشاء رمز​

  1. اذهب إلى الإعدادات > رموز الوصول
  2. اضغط على "إنشاء رمز"
  3. عبّئ التفاصيل:
    • اسم المستخدم — اسم لتمييز هذا الرمز (أحرف إنجليزية صغيرة وأرقام وشرطات فقط؛ من 3 إلى 50 حرفاً)
    • الوصف — الغرض من هذا الرمز
  4. اختر نوع الصلاحيات (انظر أدناه)

أنواع الصلاحيات​

النوعالوصف
دوراختر أحد الأدوار الجاهزة: مدير عام (Super Admin)، مدير (Admin)، مسوّق (Marketer)، موظف خدمة (Service Agent)، أو محلل (Analyst)
مخصصمصفوفة صلاحيات دقيقة لكل ميزة — اختر بالضبط الميزات والإجراءات المسموح بها

بيانات الاعتماد​

بعد الإنشاء، تظهر نافذة "تم إنشاء الرمز" وفيها:

  • معرّف العميل (Client ID) — بالصيغة svc-<tenant>-<username>
  • سر العميل (Client Secret) — يُعرَض مرة واحدة فقط
  • مثال استخدام جاهز: أمر curl بنوع منح client_credentials لنقطة نهاية الرموز يمكنك نسخه كما هو
warning

احفظ سر العميل الآن — لن يظهر مرة أخرى. إذا فُقِد، يجب أن تعيد توليده.

إدارة الرموز​

الإجراءالوصف
تعديل الصلاحياتغيّر نوع الصلاحيات أو الدور أو النطاقات المخصصة، وأدر العملاء المرتبطين. اسم المستخدم غير قابل للتعديل.
إعادة توليد السرولّد client_secret جديداً (يُلغي القديم)
تفعيل / تعطيلعطّل الرمز مؤقتاً بدون حذفه
حذفإزالة الرمز نهائياً

استخدام الرمز​

صادِق عبر تبادل رمز Keycloak باستخدام نوع منح client_credentials:

curl -X POST "https://auth.orki.ai/realms/orki/protocol/openid-connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

تتضمن الاستجابة access_token. استخدمه في ترويسة Authorization لكل استدعاءات الـ API:

curl -X GET "https://api.orki.ai/gateway/api/v1/tenants/{tenantId}/customers" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

وثائق الـ API​

تحتوي بطاقة وثائق الـ API في هذه الصفحة على روابط الوثائق التفاعلية (Swagger) لواجهات Gateway والتسويق (Marketing) والمنتجات (Products) ومواقع قاعدة المعرفة (KB Website). استخدم هذه الوثائق لاستكشاف نقاط النهاية المتاحة وصيغ الطلب/الاستجابة.

تلميح

أنشئ رموزاً منفصلة للتكاملات المختلفة حتى تتمكن من إلغاء الوصول بشكل مستقل دون التأثير على الأنظمة الأخرى.

الـ Webhooks​

تُضبَط الـ Webhooks في هذه الصفحة نفسها — بطاقة الـ Webhook تقع أسفل قائمة الرموز. استخدمها لاستقبال إشعارات الأحداث اللحظية على خادمك.

وبالاقتران مع أحداث النظام — التي يطلقها نظامك الخلفي إلى داخل Orki باستخدام هذه الرموز — تصبح هذه الصفحة مركز التكامل ثنائي الاتجاه مع أنظمتك.

الخطوات التالية​

  • Webhooks — استقبل إشعارات لحظية عند حدوث أحداث في Orki
  • أحداث النظام — أطلق أحداثاً منظَّمة على محادثة باستخدام هذه الرموز
  • إدارة الفريق — أدر أعضاء الفريق والأدوار