استخدام واجهة برمجة التطبيقات لإنشاء موقع Cato مع Postman

تشرح هذه المقالة كيفية استخدام عميل واجهة برمجة التطبيقات Postman وتنفيذ واجهات برمجة التطبيقات الخاصة بـ Cato لتوفير المواقع في تطبيق إدارة Cato.

نظرة عامة على إعداد Postman

هذه نظرة عامة عالية المستوى لإعداد Postman لتشغيل واجهة برمجة التطبيقات الخاصة بإعدادات Cato لتوفير المواقع وتحديثها.

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

  2. تحميل واستيراد مجموعة Postman والبيئة.

  3. ضبط البيئة.

  4. تشغيل واجهة برمجة التطبيقات وتوفير المواقع في الحساب.

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

مفتاح واجهة برمجة التطبيقات هو رمز يستخدمه العميل للمصادقة مع حساب Cato الخاص بك. يمكنك استخدام شاشة إدارة واجهات برمجة التطبيقات في تطبيق إدارة Cato لتوليد مفتاح واجهة برمجة التطبيقات بصلاحيات التحرير.

API Keys.png

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

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

  2. في تبويب مفاتيح API، انقر على جديد. تفتح لوحة إنشاء مفتاح API.

    image2.png

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

  4. حدد إذن API إلى تحرير.

  5. نوصي بتعيين تاريخ ينتهي فيه صلاحية مفتاح API عند الانتهاء.

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

  7. انقر على copy.png (نسخ) وانسخ المفتاح الذي تم توليده بواسطة تطبيق إدارة Cato وقم بحفظه في موقع آمن.

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

    image3.png

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

إضافة مجموعة واجهة برمجة التطبيقات Cato والبيئة إلى Postman

لقد أنشأنا مجموعة Postman وبيئة مخصصة لمساعدتك في بدء توفير المواقع باستخدام واجهة برمجة تطبيقات Cato. هذه الملفات المخصصة متاحة في مستودع Cato.

  • _cato_env_template_.postman_environment.json
  • ملفات واجهة برمجة التطبيقات للتكوين (مثل Cato Site Mutation API v1.postman_collection.json)

تحتوي بيئة Postman على متغيرات (API URL، معرف CMA للحساب، إلخ...) وتحتوي مجموعة Postman على أمثلة لنماذج GraphQL Mutation API. لاستيرادها، انقر على "استيراد"، واسحب الملف إلى النوافذ ثم انقر على استيراد:

لإضافة المجموعة والبيئة لواجهة برمجة التطبيقات Cato إلى Postman:

  1. قم بتحميل المجموعة البيئية المخصصة من هذا المقال المعرف إلى جهازك.

  2. من Postman، اختر ملف > استيراد. تفتح النافذة المنبثقة استيراد.

  3. انقر على رفع الملفات، ثم حدد الملفات التي قمت بتحميلها في الخطوة الأولى.

    Import_Files.png

  4. انقر على استيراد.

البيئة المخصصة تظهر الآن في البيئات في Postman:

image6.png

المجموعة المخصصة تظهر الآن في المجموعات في Postman:

image7.png

إعداد بيئة Postman

نوصي باستخدام بيئة Postman منفصلة لكل مستأجر Cato حيث تخزن معرف الحساب CMA ومفتاح واجهة برمجة التطبيقات.

لإنشاء بيئة جديدة في Postman:

  1. من علامة التبويب البيئة، انقر بزر الماوس الأيمن على القالب _cat_env_template_ واختر مضاعفة.

    image8.png

  2. انقر بزر الماوس الأيمن على نسخة البيئة وحدد إعادة تسمية، ثم أعد تسمية البيئة إلى اسم مستأجرك في Cato.

    image9.png

  3. انسخ مفتاح API ومعرف الحساب CMA، والصقهم في القيمة الحالية للحقلين المناسبين في البيئة ثم انقر على حفظ.

    image10.png

    يمكنك استرداد معرف حساب CMA مباشرة من عنوان URL:

    image11.png

تشغيل استدعاء واجهة برمجة التطبيقات Cato لتوفير المواقع

بعد تعريف مفتاح API ومعرف الحساب CMA لPostman

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

  1. على علامة تبويب المجموعات.

  2. في الزاوية العلوية اليمنى، اختر البيئة التي أنشأتها في الخطوة السابقة.

    image12.png

  3. من علامة تبويب المجموعات، قم بتوسيع Cato Mutation API v1 > addSocketSite > _query واختر query_stateCode.

    image13.png

  4. انقر على إرسال لتنفيذ استدعاء API. النتيجة المتوقعة هي 200 موافق وبعض البيانات.

    image14.png

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

1 من 1 وجدوا هذا مفيداً

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