مقدمة إلى API من Cato
API من Cato هو واجهة الأتمتة الأساسية للتفاعل مع البيانات ووظائف الإدارة على منصة Cato SASE. يستخدم GraphQL للبحث المرن واسترجاع البيانات بكفاءة، مما يتيح كليهما:
عمليات القراءة فقط (استخراج البيانات)
عمليات التعديل (تغييرات التكوين)
للحصول على مرجع مفصل للمخطط، راجع توثيق API لـ Cato: https://api.catonetworks.com/documentation/
نقطة نهاية API بالتنسيق: https://api.catonetworks.com/api/v1/graphql2
دورة حياة API
للحصول على نظرة شاملة حول دورة حياة API وإرشادات الاستخدام، راجع ما هو API من Cato
كيفية استخدام مفاتيح API من Cato
لمصادقة الطلبات إلى واجهة برمجة التطبيقات من Cato، قم بتضمين رأس HTTP يسمى x-api-key في عميل API الخاص بك. اضبط قيمة هذا الرأس على مفتاح API الخاص بك باستخدام التنسيق: x-api-key: <api-key>. على سبيل المثال: x-api-key: abcdef12345. يتيح لك هذا الرأس تفويض طلبك ومنح الوصول إلى نقاط النهاية الخاصة بواجهة برمجة التطبيقات من Cato استنادًا إلى الأذونات المرتبطة بمفتاحك.
سيتم توفير مفاتيح API وبيئة النسخ الاختباري بعد موافقة كاتو على وثيقة نطاق التكامل.
تغييرات المخطط
تم توثيق SLA الخاص بـ Cato للتغيرات التي قد تكون مدمرة في قسم الإعلان وإدارة التغييرات التي قد تكون مدمرة من مقال ما هو API من Cato.
تم التعرف على واجهات برمجة التطبيقات (APIs) والحقول المخطط لإنهائها كـ مهمش في توثيق API. حيثما تتوفر، يتم تقديم بديل موصى به وتاريخ الإنهاء المجدول.
بالإضافة لذلك، يتم الاتصال بالتغيرات التي قد تكون مدمرة في مقالة التغييرات المحتملة والمقرر انهاؤها في API من Cato. يُحث الشركاء التكنولوجيون بشدة على متابعة هذه المقالة لتلقي إشعارات بشأن تحديثات المخطط القادمة والتهميشات.
تحديد المعدل والانتاج العادل
سياسة تحديد المعدل تحدد الحد الأقصى لمعدل الطلب المسموح به لكل حساب وتم تصميمها لضمان استقرار النظام الأساسي وعدالة استخدام الموارد. يجب على التكاملات تنفيذ آليات إعادة المحاولة والتراجع المناسبة للتعامل مع استجابات حد المعدل. لتفاصيل، راجع مقال فهم تحديد معدل API كاتو.
نقاط النهاية الأساسية لـ API للتكامل
أدناه هي واجهات برمجة التطبيقات الأكثر شيوعًا التي يتم استخدامها خلال التكامل المبكر وابتلاع البيانات:
نوع البيانات | واجهة برمجة التطبيقات | الغرض | حالات الاستخدام النموذجية |
الأحداث الأولية / تليمترية الأمان | نقطة دخول موصى بها لاستيعاب سجلات الأحداث الأولية و الأمان التليمترية. | دخول جهاز إحصاءات سي إىم ، مراقبة الأمان، تسجيل الامتثال، كشف التهديدات. | |
سجلات التدقيق الإدارية | استرداد سجلات التدقيق لإجراءات المدير وتغييرات التكوين. | تدقيق الامتثال، تتبع التغيير، مراقبة الحوكمة. | |
تحليلات التطبيقات & التدفقات | يوفر إحصاءات استخدام التطبيقات و مقاييس أداء التدفق على مر الوقت. | مراقبة التطبيقات، تحليل أداء الشبكة، تقارير الاستخدام. | |
الحوادث الأمنية / التنبيهات | رؤى عالية المستوى في الحوادث الأمنية والتنبيهات المترابطة. | تدفقات عمل SOC، إدارة الحوادث، إثراء التنبيه. | |
مقاييس حركة المرور | مقاييس حركة المرور و الاستخدام عبر المواقع و المستخدمين البعيدين. | تحليلات استخدام الشبكة، تخطيط القدرة، ولوحات التقارير. | |
لقطة المخزون & الاتصال | حالة الاتصال ومعلومات المخزون للمواقع، المآخذ، والمستخدمين. | مراقبة البنية التحتية، رؤية الطوبولوجيا، واكتشاف البيئة. | |
جرد الأجهزة & السمات | يوفر جرد الأجهزة والسمات المرتبطة المكتشفة بواسطة المنصة. | أنظمة إدارة الأصول، رؤية IoT/OT، تصنيف الأجهزة، وتعقب الجرد. | |
مقاييس منافذ المآخذ | يوفر المقاييس الحالية والتاريخية لواجهات المنافذ والمآخذ. | مراقبة البنية الأساسية، مراقبة صحة الارتباط، تخطيط القدرة، ومعالجة مشكلات الشبكة. |
لمزيد من التعريفات التشغيلية لواجهة API واستجابات العينة، راجع المرجع لمخططات API لـ Cato.
أدوات و أمثلة مرجعية
لدعم عمليات التطوير والتكامل، يوفر Cato العديد من الموارد المرجعية:
حساب كاتو على GitHub - أمثلة على الشيفرات، أدوات مساعدة لواجهة API، دفاتر Jupyter، مجموعات Postman، والأدوات النصية للواجهة. الأمثلة:
تحليلات البيانات - دفاتر Jupyter توضح حالات استخدام تغذية الأحداث.
صندوق أدوات Cato - أدوات مساعدة متعددة الأغراض لاستهلاك API واختباره، بما في ذلك شيفرات Python لجلب الأحداث.
GraphQL Playground - أداة تفاعلية مستندة إلى المتصفح لاختبار استفسارات API. راجع واجهة API من Cato بستخدام GraphQL Playground للحصول على التفاصيل.
الخادم البعيد لـ MCP الخاص بـ Cato - يمكن من التكامل مع API الخاص بـ Cato باستخدام المساعدين الاصطناعيين والأدوات القائمة على النماذج الكبيرة عبر بروتوكول سياق النموذج (MCP). وهذا يسمح بالتفاعل مع بيانات كاتو باستخدام اللغة الطبيعية أو سير العمل المدفوع بالذكاء الاصطناعي. لمزيد من المعلومات، انظر: العمل مع الخادم البعيد لـ MCP الخاص بـ Cato.
الموارد المجتمعية والدعم
يمكن للشركاء رفع أسئلة متعلقة بـ API من خلال