المحتويات

المقدمة

نظرة عامة على واجهة برمجة التطبيقات (API) Umbrella

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

إستخدام API للحالات ومجموعات نقاط النهاية

وصول مفتاح API وانتهاء صلاحيته

دورة حياة المصادقة والرمز المميز

الوثائق والموارد

الدعم

المقدمة

يصف هذا المستند الميزات وخيارات التكوين والموارد المتاحة لمنصة واجهة برمجة التطبيقات (API) Umbrella.

نظرة عامة على واجهة برمجة التطبيقات (API) Umbrella

يوفر النظام الأساسي لواجهة برمجة التطبيقات (API) Umbrella بيئة آمنة لبناء Umbrella وتوسيعها ودمجها معها. أستخدم واجهة برمجة التطبيقات (API) لإنشاء عمليات سير عمل عبر الأنظمة الأساسية تقوم بتجميع معلومات التهديد مع حلول أمنية أخرى لتوسيع عملية التنفيذ وزيادة مستوى الرؤية وأتمتة الاستجابة للحوادث.

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

- تتم إستضافة جميع نقاط نهاية Umbrella API فيapi.umbrella.com.

- يتم تجميع نقاط النهاية حسب حالة الاستخدام، لكل منها مسار معين.

- قم بإدارة مفاتيح واجهة برمجة التطبيقات (API) في لوحة التحكم Umbrella تحت Admin > مفاتيح API أو برمجية باستخدام KeyAdmin API.

إستخدام API للحالات ومجموعات نقاط النهاية

قم بتكوين كل مفتاح API باستخدام نطاقات متعددة المستويات مجمعة تحت حالات الاستخدام الأساسية التالية:

- نقاط نهاية واجهة برمجة تطبيقات Admin: توفير مفاتيح ومستخدمي واجهة برمجة التطبيقات وإدارتها وعرض الأدوار وإدارة العملاء للمزودين والمزودين الذين تتم إدارتهم.

- نقاط نهاية واجهة برمجة تطبيقات Auth: تخويل عمليات التكامل بين Umbrella والخدمات الأخرى.

- نقاط نهاية واجهة برمجة التطبيقات لعمليات النشر: توفير الشبكات والكيانات ومراقبتها وإدارتها وتأمينها من خلال تكوينها في سياسات المظلة القائمة.

- نقاط نهاية واجهة برمجة تطبيقات السياسات: توفير قوائم وجهات الوجهة لكل قائمة وإدارتها.

- التحقيق في نقاط نهاية واجهة برمجة التطبيقات: مجالات البحث وعناوين IP وعناوين URLs التي تمت ملاحظتها بواسطة محللي Umbrella.

- نقاط نهاية واجهة برمجة التطبيقات للتقارير: قراءة معلومات الأمان في الوقت الفعلي حول عمليات النشر ومراجعتها. توفر واجهة برمجة التطبيقات لاكتشاف التطبيقات رؤى للتطبيقات المستندة إلى مجموعة النظراء.

وصول مفتاح API وانتهاء صلاحيته

- قم بتعيين مستوى الوصول لكل نطاق للقراءة / الكتابة أو للقراءة فقط وفقا للاستخدام المقصود.

- قم بتكوين مفاتيح API بحيث تنتهي صلاحيتها في تاريخ محدد مسبقا كما هو مطلوب.

15143392160916

دورة حياة المصادقة والرمز المميز

- تقوم بيانات اعتماد واجهة برمجة التطبيقات بإنشاء رموز مميزة للوصول صالحة لمدة 60 دقيقة.

- تستخدم عملية المصادقة تدفق بيانات اعتماد عميل OAuth 2.0.

- في بيئات المؤسسات المتعددة أو مزودي الخدمة، يمكن أن تقوم بيانات اعتماد واجهة برمجة التطبيقات (API) الخاصة بالمؤسسة الأصلية بإنشاء رموز مميزة للوصول ذات النطاقات نفسها الخاصة بمؤسسة فرعية محددة أثناء التفويض.

الوثائق والموارد

- يمكنك الوصول إلى التعليمات الشاملة واستخدام وثائق الحالة.

- يتم توثيق كل حالة إستخدام لواجهة برمجة التطبيقات ضمن مرجع واجهة برمجة التطبيقات.

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

- إذا كنت تستخدم واجهات برمجة تطبيقات Legacy Umbrella API، فراجع دليل ترحيل واجهة برمجة التطبيقات (API).

- أستخدم مجموعة Postman ل Umbrella API للاختبار الأولي.

- استكشف الموارد الإضافية، ومختبرات التعلم، وآلية تحديد الوصول لاختبارات واجهة برمجة التطبيقات (API) في قسم أمان السحابة في صفحة مطور Cisco.

الدعم

للحصول على أسئلة أو مساعدة إضافية مع واجهة برمجة التطبيقات (API) Umbrella، اتصل بدعم Umbrella.