الاتصال بـ Cato API من واجهة GraphQL Playground

توضح هذه المقالة كيفية استخدام واجهة GraphQL Playground لتشغيل بعض استعلامات العينة واختبار الاتصال بنقطة النهاية لـ Cato Networks API.

نظرة عامة على GraphQL Playground

يسمح لك GraphQL Playground بتشغيل استعلامات API التي يتم إرسالها مباشرة إلى خادم Cato API. توفر برمجيات الاستعلام API التابعة لجهات خارجية مثل Altair أو Postman وظيفة قوية لتشغيل استدعاءات API. ومع ذلك، إذا كانت هناك مشكلة في الاتصال باستعلامات API، يمكنك استخدام Playground للمساعدة في تحديد سبب المشكلة.

المتطلبات المسبقة

لتشغيل استعلام Cato API من واجهة GraphQL Playground، يجب أن يكون لديك مفتاح API لحسابك (الموارد > مفاتيح API). لمزيد من المعلومات حول مفاتيح API، انظر توليد مفاتيح API لـ Cato API.

تحتاج إلى إدخال معرف تطبيق إدارة Cato (CMA) لحسابك في استعلامات العينة. يمكنك العثور على معرف CMA في صفحة معلومات الحساب.

يكون عنوان URL لنقطة النهاية API خاصًا بالموقع الذي يتم فيه استضافة نسخة تطبيق إدارة Cato (CMA). قد يكون هناك قيمة <prefix> يتم إضافتها إلى عنوان URL لحساب CMA الخاص بك وإلى نقطة النهاية API.

  • إذا لم يكن هناك بادئة (cc.catonetworks.com)، فاستخدم عنوان URL التالي: https://api.catonetworks.com/api/v1/graphql2

  • إذا كان هناك بادئة (مثل cc.us1.catonetworks.com)، فيجب عليك استخدام عنوان URL التالي: https://api.us1.catonetworks.com/api/v1/graphql2

اختبار الاتصال باستعلامات Cato API العينة

يمكنك تشغيل استعلام API العينة لاختبار الاتصال بخادم Cato API. عند تكوين حجة accountID ومفتاح API بشكل صحيح، يعيد استعلام API العينة بيانات الحساب ويعرض النتائج في واجهة GraphQL Playground. إذا لم يُرجع الاستعلام نتائج لحسابك، فقد تكون هناك مشكلة اتصال بالخادم API أو ربما يكون الخادم متعطلًا. يمكن أن تساعدك استعلامات API العينة التالية في اختبار الاتصال بخادم Cato API:

تشغيل استعلام API عينة في GraphQL Playground

استخدم متصفح الإنترنت لفتح GraphQL Playground لـ Cato API. قم بتكوين رأس HTTP لـ Playground باستخدام مفتاح API الخاص بك. ألصق الاستعلام العينة في الجزء الأيسر وأدخل معرف الحساب الخاص بك. ثم يمكنك تشغيل الاستعلام ورؤية النتائج في Playground.

  1. قم بتنزيل أحد استعلامات API العينة من هذه المقالة وافتح الملف في محرر نصوص مثل Notepad.

  2. من متصفح الإنترنت، انتقل إلى GraphQL Playground لـ Cato API.

  3. في أسفل الجزء الأيسر، اضغط رؤوس HTTP.

  4. أدخل مفتاح API الخاص بك بهذا التنسيق: { "x-api-key" :"<api key>" }.

    توضح لقطة الشاشة التالية تهيئات رأس HTTP بمفتاح APIAaBbCcDdEeFf0123456789ABCDEF1234:

    graphql1.png

  5. انسخ والصق أحد استعلامات العينة في الجزء الأيسر من Playground.

  6. في أعلى الاستعلام، في حجة accountID أدخل معرف الحساب الخاص بك.

    توضح لقطة الشاشة التالية حجة accountID المضبوطة بالقيمة 2626:

    graphql2.png

  7. اضغط على زر التشغيل.

  8. يعرض الجزء الأيمن نتائج استعلام API. توضح لقطة الشاشة التالية نتائج استعلام accountMetrics العينة لمعرف الحساب 2626:

    graphql3.png

هل كان هذا المقال مفيداً؟

2 من 3 وجدوا هذا مفيداً

لا توجد تعليقات