إنشاء مفاتيح API لواجهة برمجة التطبيقات من Cato

هناك صفحات CMA منفصلة لنوعين من مفاتيح API:

• مفاتيح API - للاستخدام الشخصي لمديري الأفراد

• مفاتيح الخدمة - للاستخدام المشترك بين مختلف المدراء الرئيسيين للخدمة

نظرة عامة

تتيح لك Cato توليد مفاتيح API في تطبيق إدارة Cato (CMA) التي تُستخدم لمصادقة نداءات API إلى خادم Cato API. أدخل مفتاح API لأجل عميل API، الكود، السكريبتات، التكامل مع SIEM، MCP، والمزيد للتفاعل الآمن مع خدمات Cato.

هذه هي أنواع مفاتيح API:

• مفاتيح API للمسؤول هي مفاتيح شخصية مرتبطة بحساب المسؤول الخاص بك، والتي تستخدمها لعمليات سير العمل الخاصة بك في API. يمكنك إنشاء مفاتيح API للمسؤول فقط لنفسك. لمزيد من المعلومات، راجع أدناه مفاتيح API للمسؤول.

• مفاتيح API للخدمة هي مفاتيح مشتركة تُستخدم بواسطة عمليات النظام أو الأتمتة أو تكامل الأطراف الثالثة. هذه المفاتيح ليست مرتبطة بتسجيل دخول مسؤول فردي وتناسب بشكل أفضل حالات الاستخدام العملياتية. للحصول على مزيد من المعلومات، انظر أدناه مفاتيح API الرئيسية للخدمة.

توفر Cato دعمًا دقيقًا لمستويين من نداءات API:

• استعلامات APIs - تنفيذ نداءات API للقراءة فقط لاسترداد البيانات لحسابك

  أذونات المشاهد تسمح لك فقط بتشغيل نداءات API للاستعلام. ينطبق هذا سواء تم تعيين الأذونات من خلال دور أو تقييدها على صفحات معينة في CMA.

• تكوين APIs - إجراء نداءات API للكتابة لإجراء تغييرات في التكوين لحسابك

  أذونات التحرير تسمح لك فقط بتشغيل نداءات API للتكوين أو الاستعلام. ينطبق هذا سواء تم تعيين الأذونات من خلال دور أو تقييدها على صفحات معينة في CMA.

إضافة مفاتيح API إلى عميل API

لمصادقة الطلبات إلى واجهة برمجة التطبيقات من Cato، قم بتضمين رأس HTTP يسمى x-api-key في عميل API الخاص بك. اضبط قيمة هذا الرأس إلى مفتاح Cato API الخاص بك باستخدام التنسيق: x-api-key: <api-key>. على سبيل المثال: x-api-key: abcdef12345. يتيح لك هذا الرأس تفويض طلبك ومنح الوصول إلى نقاط النهاية الخاصة بواجهة برمجة التطبيقات من Cato استنادًا إلى الأذونات المرتبطة بمفتاحك.

المسؤولون الخدميون

مسؤول الخدمة الرئيسي هو نوع خاص من المسؤولين CMA تم إنشاؤه خصيصًا لتدفقات العمل القائمة على API. لدعم تكامل الأنظمة والعمليات الآليّة بأمان، قم بإنشاء مسؤولين رئيسيين للخدمة في حسابك. يسمح لك هذا بتوليد مفاتيح API غير مرتبطة ببيانات تسجيل الدخول الشخصية ولا يمكن استخدامها للوصول إلى CMA.

تُستخدم بيانات اعتماد مدير الخدمة الرئيسي بشكل حصري لمصادقة API مع مفتاح API الخدمي المقابل. تعزز هذه الإعدادات الأمان وتفرض فصل المهام للعمليات الآلية.

ملاحظة: يتم تلقائيًا إنشاء مسؤول CMA جديد باسم المسؤول عن الخدمة التلقائية (محرر) كجزء من إضافة مفتاح API المسؤول عن الخدمة إلى الحسابات الحالية.

لإنشاء مدير خدمة رئيسي:

1. من قائمة التنقل، انقر على الحساب > المديرين.

2. انقر فوق جديد.

   يفتح لوحة إنشاء مدير.

3. اختر إنشاء جديد، وإنشاء كخدمة رئيسية.

4. أدخل الإعدادات العامة للمدير.

5. اختر الدور وأي مواقع ومستخدمين محددين من شأنها تحديد الأذونات لهذا المدير. للتعرف على الأدوار، انظر إدارة أدوار المدير باستخدام RBAC.

   سيتم تطبيق هذه الأذونات على مفتاح API الخدمي الرئيسي.

6. اضغط تطبيق. يُضاف المدير إلى صفحة الإداريون، ويتم تفعيل مدير الخدمة الرئيسي تلقائيًا.

توليد مفاتيح API

صفحات مفاتيح API ومفاتيح API الخدمية تتيح لك توليد وإلغاء مفاتيح API. يُستخدم الاسم لمفتاح API فقط لتحديد كل مفتاح ولا يُستخدم كجزء من عملية المصادقة.

لأمان إضافي، يمكنك تقييد IPs المصدر أو نطاق IP (CIDR) لمفاتيح API وخدمة API.

ملاحظة: تأكد من نسخ قيمة مفتاح API من النافذة المنبثقة. بعد إغلاق النافذة المنبثقة، لا يمكنك الوصول إلى قيمة المفتاح مرة أخرى.

مفاتيح واجهة برمجة التطبيقات الإدارية

عندما تحتاج إلى دعم عمليات الأتمتة الخاصة بك كمدير فردي، قم بإنشاء مفتاح API إداري متصل ببيانات المدير الخاصة بك في CMA. يمكنك فقط إنشاء مفاتيح API الإدارية لاستخدامك الشخصي وليس للمديرين الآخرين، وذلك فقط عبر CMA.

عند حذف مدير، يتم إلغاء تفعيل مفتاح API المرتبط به تلقائيًا. إذا تم تعطيل مدير، يتم تعيين المفتاح كـ معطّل، وستعيد مكالمات API باستخدامه خطأ.

أذونات RBAC لمفاتيح API الإدارية

• كل مفتاح API إداري يرث أذونات RBAC وأدوار المدير الذي أنشأه. تُحدث الأذونات ديناميكيًا إذا تغيرت أدوار RBAC للمدير، بما في ذلك الأذونات للمواقع المحددة، ومجموعات المستخدمين، والمجموعات،...الخ

• المديرون الذين لديهم دور مشاهد يمكنهم رؤية جميع معلومات مفتاح API (ليس قيمة المفتاح الفعلية)

• المديرون الذين لديهم دور RBAC محرر الذي يشمل صفحة مفاتيح API يمكنهم رؤية مفاتيح API في الحساب وإلغاء (حذف) تلك المفاتيح

لتوليد مفتاح API إداري:

1. في قائمة التنقل، انقر على الموارد > مفاتيح API الإدارية.

2. اضغط على جديد. يفتح اللوحة إنشاء مفتاح API.

3. أدخل اسم المفتاح.

4. لتطبيق أذونات العرض فقط لهذا المفتاح، اختر خفض إلى عرض.

5. (اختياري) من أجل أمان إضافي، في السماح بالوصول من IPs، اختر قائمة IP محددة، وحدد عناوين IP أو نطاق IP المسموح لها باستخدام هذا مفتاح API.

   الإعداد الافتراضي هو السماح لهذا مفتاح API لأي عنوان IP.

6. (اختياري) اختر التاريخ الذي ينتهي فيه مفتاح API.

   بالنسبة لمفاتيح API التي تحتوي على أذونات التعديل، نوصي بتحديد تاريخ ينتهي فيه مفتاح API عند التاريخ المحدد.

7. اضغط تطبيق. تمت إضافة مفتاح API إلى الصفحة، وتظهر نافذة منبثقة تحتوي على القيمة لمفتاح API الجديد.

8. انقر على الزر لنسخ المفتاح المنشي بواسطة CMA واحتفظ به في مكان آمن.

   بمجرد إغلاق هذه النافذة، لا يمكنك الوصول إلى القيمة لمفتاح API.

9. انقر على موافق لإغلاق النافذة المنبثقة.

مفاتيح API خدمية رئيسية

عندما تحتاج إلى دعم عمليات التشغيل أو التكامل المشتركة، قم بإنشاء مفتاح API خدمي من صفحة مفاتيح API الخدمية. تم تصميم هذه المفاتيح للاستخدام من قبل خدمات الأتمتة والسكريبتات التي لا تتطلب الوصول إلى CMA. يتم الاتصال بمسؤول الخدمة الرئيسي الذي قام بإنشاء المفتاح.

يمكن استخدام مفاتيح API الخدمية عبر الأنظمة والفرق، مما يمكن من التكامل القابل للتوسع مع الأدوات والخدمات الخارجية. لا ترتبط هذه الأنواع من المفاتيح بمدير CMA وهي مخصصة للعمليات الخلفية أو خطوط التسليم المستمرة.

أذونات RBAC لمفاتيح API الخدمية

• فقط المديرون الذين لديهم دور محرر يمكنهم إنشاء أو إدارة مفاتيح API الخدمية الرئيسية

• كل مفتاح API خدمي يرث أذونات RBAC وأدوار مدير الخدمة الرئيسي المرتبط بالمفتاح. إذا تغيرت أذونات RBAC للمدير، يتم تحديث مفتاح API الخدمي الرئيسي تلقائيًا بالأذونات الجديدة.

لإنشاء مفتاح API للخدمة:

1. في قائمة التنقل، انقر على الموارد > مفاتيح API للخدمة.

2. اضغط جديد. يفتح اللوحة إنشاء مفتاح API.

3. حدد الخدمة الرئيسية المرتبطة بهذا المفتاح.

4. ادخل اسم المفتاح.

5. لتطبيق أذونات العرض فقط لهذا المفتاح، اختر خفض إلى عرض.

6. (اختياري) من أجل أمان إضافي، في السماح بالوصول من IPs، اختر قائمة IP محددة، وحدد عناوين IP أو نطاق IP المسموح لها باستخدام هذا مفتاح API.

   الإعداد الافتراضي هو السماح لهذا مفتاح API لأي عنوان IP.

7. (اختياري) اختر التاريخ الذي ينتهي فيه مفتاح API.

   بالنسبة لمفاتيح API التي تحتوي على أذونات التعديل، نوصي بتحديد تاريخ ينتهي فيه مفتاح API عند التاريخ المحدد.

8. اضغط تطبيق. تمت إضافة مفتاح API إلى الصفحة، وتظهر نافذة منبثقة تحتوي على القيمة لمفتاح API الجديد.

9. انقر على الزر لنسخ المفتاح المنشي بواسطة CMA واحتفظ به في مكان آمن.

   بمجرد إغلاق هذه النافذة، لا يمكنك الوصول إلى القيمة لمفتاح API.

10. انقر على موافق لإغلاق النافذة المنبثقة.

إلغاء مفتاح API

يمكنك إلغاء مفتاح API وإزالته من CMA. بمجرد إلغاء المفتاح، لا يمكن استخدامه للمصادقة إلى خادم API.

لإلغاء مفتاح API:

1. في قائمة التنقل، انقر على الموارد > مفاتيح API الإدارية أو مفاتيح API للخدمة.

2. في الصف مع مفتاح API، انقر على رمز الحذف في نهاية الصف.

3. في نافذة التأكيد، انقر على حذف. يتم إلغاء مفتاح API وإزالته من حسابك.