الرئيسية / الوثائق / مفاتيح API للتكامل
مفاتيح API للتكامل

إنشاء / تدوير / إلغاء العميل

دليل منشور من وثائق Survanta العامة.

إنشاء عملاء التكامل وتدوير مفاتيحهم وإلغاؤهم

تُدار مفاتيح عملاء التكامل عبر شاشة لوحة التحكم TenantIntegrationClients. يستطيع مسؤول مؤسسة مخوّل أو مستخدم منصة مخوّل يعمل ضمن سياق صالح لمؤسسة محددة استخدام هذه الشاشة. يمثل كل عميل نظامًا خارجيًا أو تكاملًا واحدًا ويحمل مفتاح API الخاص به ومجموعة نطاقاته.

إنشاء عميل تكامل جديد

  1. سجّل الدخول إلى لوحة التحكم باستخدام حساب مؤسسة أو منصة مخوّل.
  2. افتح شاشة إدارة عملاء التكامل (TenantIntegrationClients). يتطلب مسار المؤسسة صفة مسؤول المؤسسة والعضوية في مجموعة مسؤولي المؤسسة. ويتطلب مسار المنصة مؤسسة محددة صالحة وصلاحية إدارة تكاملات المؤسسات.
  3. انقر على إضافة عميل جديد.
  4. أدخل الحقول:
    • اسم العميل — تسمية وصفية تعرف النظام الخارجي (مثلا، "لوحة ذكاء الأعمال" أو "وظيفة ETL الليلية").
    • الوصف — سياق اختياري للمسؤولين.
    • النطاقات — اختر من ReportsRead وUsageRead وRawResponsesRead. يجب أن تفعّل الخطة الوصول إلى API التقارير لنطاقي ReportsRead وUsageRead، والوصول إلى API الاستجابات الخام لنطاق RawResponsesRead.
    • تاريخ الانتهاء — مطلوب وفي المستقبل ولا يتجاوز الحد الأقصى المضبوط؛ ويطبق حد أقصر عند وجود RawResponsesRead.
  5. انقر على إنشاء. يولد النظام مفتاح API جديدا ويعرضه مرة واحدة في هذه النقطة.
  6. انسخ المفتاح فورا واحفظه في مدير الأسرار. قيمة المفتاح الكاملة غير قابلة للاسترداد بعد إغلاق هذه الشاشة.

يُجزَّأ المفتاح قبل التخزين. لا يستطيع Survanta استرداد مفتاح مفقود. إذا فُقد المفتاح، دوّره فورا.

تدوير مفتاح API

يستبدل تدوير المفتاح المفتاح الحالي بمفتاح جديد مع الحفاظ على سجل العميل ونطاقاته المعينة. دوّر مفتاحا كلما احتمل تعرضه للاختراق أو كجزء من سياسة تدوير أمان مجدولة.

  1. في قائمة عملاء التكامل، حدد موقع العميل بالاسم.
  2. انقر على تدوير المفتاح في قائمة إجراءات العميل.
  3. أكد التدوير. يُلغى المفتاح القديم فورا.
  4. انسخ المفتاح الجديد واحفظه من شاشة السر لمرة واحدة ذات منع التخزين المؤقت، ثم حدّث النظام المستهلك. يضبط التدوير أيضًا مدة انتهاء قصوى جديدة، ويفعل العميل، ويمسح الإلغاء.

لا توجد فترة سماح — يتوقف المفتاح القديم عن العمل لحظة تأكيد التدوير. نسّق مع مستهلك التكامل قبل التدوير في بيئة الإنتاج.

إلغاء عميل

يعطّل إلغاء العميل العميل ويبطل مفتاحه مع الاحتفاظ بالسجل لأغراض التدقيق. استخدم هذا الإجراء عند إيقاف تشغيل تكامل.

  1. في الإعدادات → عملاء التكامل، حدد موقع العميل.
  2. انقر على إلغاء. تعرض وحدة التحكم الحالية الإلغاء لا الحذف النهائي.
  3. أكّد الإلغاء. يحصل أي طلب لاحق يستخدم المفتاح القديم على 401 Unauthorized مع ضبط errorMessage على Authentication is required. Provide valid credentials or a valid API key.

عرض العملاء الحاليين

تعرض قائمة عملاء التكامل:

الحقل الوصف
المعرّف معرّف العميل
اسم العميل / الوصف التسمية والوصف الاختياري
النطاقات النطاقات المعينة لهذا العميل
الحالة نشط أو ملغى وفق حالة العميل الحالية
آخر استخدام طابع أحدث طلب نجحت مصادقته
الإجراءات التدقيق والتدوير والإلغاء

يُعرض كل مفتاح مُنشأ مرة واحدة بعد الإنشاء أو التدوير، ولا يمكن استرداده لاحقًا.

قواعد تعيين النطاقات

  • يمكن للعميل أن يحمل أي تركيبة من ReportsRead وUsageRead وRawResponsesRead.
  • لا تُوضع النطاقات أبدا داخل مجموعات صلاحيات المستخدمين.
  • تدعم خدمة التطبيق تحديث البيانات الوصفية والنطاقات بعد التحقق، لكن وحدة تحكم المؤسسة الحالية تعرض القائمة والإنشاء والتدوير والإلغاء والتدقيق فقط؛ فلا توثق إجراء تعديل غير موجه.
  • قد يؤدي خفض الخطة إلى إلغاء العملاء النشطين الأحدث الزائدين بشكل حتمي، ولا يستهلك العملاء المنتهون سعة الحصة.

الدعم

يرجى تسجيل الدخول أو إنشاء حساب للدردشة مع فريق الدعم.