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

أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
info

يمكنك إدارة منتجات واجهة برمجة التطبيقات باستخدام واجهة مستخدم إدارة Apigee Edge، كما هو موضّح في هذا القسم. لإدارة منتج واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات، يُرجى الاطّلاع على استخدام واجهة برمجة التطبيقات Edge Management API لنشر واجهات برمجة التطبيقات.

شاهِد الفيديو التالي لمعرفة كيفية إنشاء منتج واجهة برمجة تطبيقات.

للحصول على نظرة عامة على منتجات واجهة برمجة التطبيقات، يُرجى الاطّلاع على المقالة ما هو منتج واجهة برمجة التطبيقات؟.

استكشاف صفحة منتجات واجهة برمجة التطبيقات

انتقِل إلى صفحة منتجات واجهة برمجة التطبيقات، كما هو موضَّح أدناه.

Edge

للوصول إلى صفحة منتجات واجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge:

  1. سجِّل الدخول إلى https://apigee.com/edge.
  2. انقر على Publish (نشر) > API Products (منتجات واجهة برمجة التطبيقات).

ستظهر صفحة "منتجات واجهة برمجة التطبيقات".

صفحة "منتجات واجهة برمجة التطبيقات" التي تعرض قائمة بمنتجات واجهة برمجة التطبيقات يتم توفير وسائل شرح توضح المهام التي يمكنك إنجازها، والمدرجة أسفل الشكل.

كما هو موضّح في الشكل السابق، تتيح لك صفحة منتجات واجهة برمجة التطبيقات تنفيذ المهام التالية، الموضّحة لاحقًا في هذا القسم:

واجهة مستخدم Edge الجديدة (السحابة الإلكترونية الخاصة)

للوصول إلى صفحة منتجات واجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge الجديدة:

  1. سجِّل الدخول إلى واجهة مستخدم New Edge على الرابط http://host:3001/edge، حيث يمثّل host عنوان IP أو اسم نظام أسماء النطاقات للمضيف الذي يشغّل واجهة مستخدم New Edge.
  2. انقر على Publish (نشر) > API Products (منتجات واجهة برمجة التطبيقات).

ستظهر صفحة "منتجات واجهة برمجة التطبيقات".

صفحة "منتجات واجهة برمجة التطبيقات" التي تعرض قائمة بمنتجات واجهة برمجة التطبيقات يتم توفير وسائل شرح توضح المهام التي يمكنك إنجازها، والمدرجة أسفل الشكل.

كما هو موضّح في الشكل السابق، تتيح لك صفحة منتجات واجهة برمجة التطبيقات تنفيذ المهام التالية، الموضّحة لاحقًا في هذا القسم:

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

أضِف منتج واجهة برمجة تطبيقات باستخدام واجهة المستخدم، كما هو موضّح أدناه. لاستخدام Edge API، يُرجى الاطّلاع على ضبط منتجات واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات.

لإضافة منتج واجهة برمجة تطبيقات باستخدام واجهة مستخدم Edge:

  1. انتقِل إلى صفحة منتجات واجهة برمجة التطبيقات، كما هو موضّح سابقًا في هذا القسم.
  2. انقر على +منتج واجهة برمجة التطبيقات.
  3. أدخِل تفاصيل منتج واجهة برمجة التطبيقات.
    الحقل الوصف
    الاسم الاسم الداخلي لمنتج واجهة برمجة التطبيقات لا يمكنك تعديل الاسم بعد إنشاء منتج واجهة برمجة التطبيقات. لا تحدِّد رموزًا خاصة في الاسم.
    الاسم المعروض الاسم المعروض لمنتج واجهة برمجة التطبيقات يتم استخدام الاسم المعروض في واجهة المستخدم ويمكنك تعديله في أي وقت. في حال عدم تحديدها، سيتم استخدام قيمة "الاسم". تتم تعبئة هذا الحقل تلقائيًا باستخدام قيمة "الاسم"، ويمكنك تعديل محتواه أو حذفه. يمكن أن يتضمّن الاسم المعروض رموزًا خاصة.
    الوصف وصف منتج واجهة برمجة التطبيقات
    البيئة البيئات التي سيسمح منتج واجهة برمجة التطبيقات بالوصول إليها على سبيل المثال، test أو prod.
    إذن الوصول مستوى الوصول لمعرفة التفاصيل، يُرجى الاطّلاع على مستوى الوصول.
    الموافقة تلقائيًا على طلبات الوصول يمكنك تفعيل الموافقة التلقائية على طلبات المفاتيح لمنتج واجهة برمجة التطبيقات هذا من أي تطبيق. لطلب الموافقة اليدوية على المفاتيح، يمكنك إيقاف هذا الخيار. يُرجى الاطّلاع على تسجيل التطبيقات وإدارة مفاتيح واجهة برمجة التطبيقات (واجهة المستخدم) ومفاتيح تطبيقات المطوّرين (واجهة برمجة التطبيقات).
    الحصة حدّ الحصة الذي تريد الإشارة إليه من سياسات الحصص. لا يؤدي إدخال قيمة حصة إلى فرض قيود تلقائيًا على عدد المكالمات التي يمكن إجراؤها من خلال المنتج. يجب أن تتضمّن الخوادم الوكيلة لواجهة برمجة التطبيقات التي يشير إليها المنتج سياسة "الحصة" لفرض الحصة. لمزيد من المعلومات، يُرجى الاطّلاع على الحصص.
    نطاقات OAuth المسموح بها إذا كنت تستخدم OAuth مع منتج واجهة برمجة التطبيقات، يمكنك تحديد نطاقات OAuth المسموح بها والتي تريد أن يسمح بها منتج واجهة برمجة التطبيقات (مثل نطاقات القراءة أو النطاقات الأخرى التي سترسلها التطبيقات مع طلبات البيانات من واجهة برمجة التطبيقات). حدِّد نطاقات متعددة كقائمة قيم مفصولة بفاصلة. يُرجى الاطّلاع على نطاقات OAuth.
  4. أضِف موارد واجهة برمجة التطبيقات المتاحة في منتج واجهة برمجة التطبيقات، بما في ذلك الخوادم الوكيلة لواجهة برمجة التطبيقات ومسارات الموارد.

    على سبيل المثال، إذا أضفت وكيل واجهة برمجة تطبيقات "موسيقى" إلى المنتج بمسار أساسي /music، يسمح منتج واجهة برمجة التطبيقات بالطلبات إلى /music. ومع ذلك، إذا أردت أن يسمح منتج واجهة برمجة التطبيقات بالوصول إلى مسار المورد venues فقط، الذي يحتوي على معرّف الموارد المنتظم (URI) /music/venues، أضِف مسار المورد /venues إلى المنتج. في هذه الحالة، يُسمح بالمكالمات الواردة من "/music/venues?name=paramount"، ولكن سيتم حظر المكالمات الواردة من "/music/artists?name=Jack%Johnson".

    اضبط مسارًا محدّدًا للمورد أو اضبط المسار الأساسي وجميع المسارات الفرعية المحتملة من خلال تحديد مسار المورد على أنّه /. يمكن أن يتضمّن مسار المورد أحرف البدل /** و/*. تشير علامة النجمة المزدوجة إلى أنّ جميع المسارات الفرعية للمسار الأساسي متوافقة (ولكن ليس المسار الأساسي). تشير علامة النجمة الواحدة إلى أنّه لا يمكن استخدام سوى معرّفات الموارد المنتظمة (URI) التي تقع في مستوى واحد أسفل المسار الأساسي. يُرجى الاطّلاع على ضبط سلوك مسار المورد "/" و"/*" و"/**"، كما هو موضّح لاحقًا في هذا القسم.

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

    1. انقر على إضافة خادم وكيل أو إضافة مسار في قسم موارد واجهة برمجة التطبيقات.
    2. اختَر ما إذا كنت تريد إضافة خادم وكيل لواجهة برمجة التطبيقات أو مسار أو كليهما خادم وكيل لواجهة برمجة التطبيقات ومسار.

      يتيح لك قسم "إضافة مورد واجهة برمجة التطبيقات" إضافة خادم وكيل لواجهة برمجة التطبيقات أو مسار مورد أو كليهما.

    3. أضِف خادمًا وكيلاً واحدًا أو أكثر لواجهة برمجة التطبيقات ومسارات الموارد.

      يُرجى ملاحظة ما يلي:

      • تنطبق مسارات الموارد التي تحدّدها على جميع الخوادم الوكيلة لواجهة برمجة التطبيقات التي تتم إضافتها إلى منتج واجهة برمجة التطبيقات. لا يفلتر مسار المورد سوى اللاحقات بعد المسار الأساسي.
      • إذا نشرت في الوقت نفسه نُسخًا من الوكيل بمسارات أساسية مختلفة، سيتم تطبيق جميع المسارات الأساسية النشطة، حتى إذا كانت واجهة مستخدم منتج واجهة برمجة التطبيقات تعرض مسارًا أساسيًا واحدًا فقط.
      • وتكون الأولوية لمسارات الموارد الأكثر شمولاً والأقل تحديدًا على تلك الأكثر تحديدًا. على سبيل المثال، إذا أضفت / و/**، ستكون الأولوية لمسار المورد /، وسيتم تجاهل مسار المورد /**.

      على سبيل المثال:

      تم تطبيق مسار المورد على جميع الخوادم الوكيلة لواجهة برمجة التطبيقات، وتم تجاهل مسار المورد الأكثر تحديدًا

    4. انقر على إضافة أو إضافة وبدء مورد آخر (لتحديد موارد واجهة برمجة تطبيقات إضافية).
  5. (اختياري) استخدِم قسم أهداف خدمة Apigee عن بُعد لربط المنتج بهدف واحد أو أكثر من أهداف الخدمة عن بُعد. يمكنك تجاهل هذا الإعداد ما لم تكن تستخدم Apigee Envoy Adapter. لمزيد من المعلومات، يُرجى الاطّلاع على دليل العمليات الخاص بـ Apigee Envoy Adapter.
  6. (اختياري) استخدِم قسم السمات المخصّصة لإضافة ما يصل إلى 18 سمة مخصّصة إلى منتج API.

    السمات المخصّصة هي أزواج مفاتيح/قيم يمكن استخدامها بعدة طرق، بما في ذلك المساعدة في التحكّم في تنفيذ الخادم الوكيل لواجهة برمجة التطبيقات. على سبيل المثال، يمكنك إنشاء سمة مخصّصة باسم deprecated بقيمة "صحيح" أو "خطأ". في مسار الخادم الوكيل لواجهة برمجة التطبيقات، يمكنك التحقّق من قيمة سمة deprecated لمنتج واجهة برمجة التطبيقات (على سبيل المثال، باستخدام المتغيّر verifyapikey.{policy_name}.apiproduct.deprecated الذي يتوفّر تلقائيًا بعد إنشاء السمة المخصّصة). إذا كانت قيمته صحيحة (تم إيقافه نهائيًا)، يمكنك عرض خطأ باستخدام سياسة "إظهار الخطأ".

  7. انقر على حفظ.

ضبط سلوك مسار المورد على "/" و"/*" و"/**"

يوضّح الجدول التالي الإعدادات التلقائية لمنتج واجهة برمجة التطبيقات في ما يتعلّق بمسارات الموارد المختلفة. في هذا المثال، يحتوي الخادم الوكيل لواجهة برمجة التطبيقات على مسار أساسي هو /v1/weatherapikey. ينطبق مسار مورد منتج واجهة برمجة التطبيقات على لاحقة المسار بعد المسار الأساسي.

عنوان URI للطلب مسموح به لـ / مسموح به لـ /* مسموح به لـ /** مسموح به لـ /*/2/** مسموح به لـ /*/2/*‎

/v1/weatherapikey

نعم

لا

لا

لا

لا

/v1/weatherapikey/

نعم

لا

لا

لا

لا

/v1/weatherapikey/1

نعم

نعم

نعم

لا

لا

/v1/weatherapikey/1/

نعم

نعم

نعم

لا

لا

/v1/weatherapikey/1/2

نعم

لا

نعم

لا

لا

/v1/weatherapikey/1/2/

نعم

لا

نعم

نعم

لا

/v1/weatherapikey/1/2/3/

نعم

لا

نعم

نعم

نعم

/v1/weatherapikey/1/a/2/3/

نعم

لا

نعم

لا

لا

بشكل تلقائي، يتيح مسار المورد / في منتج واجهة برمجة التطبيقات استخدام المسار الأساسي وجميع المسارات الفرعية. على سبيل المثال، إذا كان المسار الأساسي لخادم وكيل واجهة برمجة التطبيقات هو /v1/weatherapikey، يدعم منتج واجهة برمجة التطبيقات الطلبات إلى /v1/weatherapikey وإلى أي مسارات فرعية، مثل /v1/weatherapikey/forecastrss و/v1/weatherapikey/region/CA وما إلى ذلك.

يمكنك تغيير هذا الإعداد التلقائي بحيث يتوافق مسار المورد / مع المسار الأساسي لوكيل واجهة برمجة التطبيقات فقط، ما يعني أنّ منتج واجهة برمجة التطبيقات لن يسمح بالوصول إلى معرّف موارد منتظم (URI) يتضمّن أي شيء بعد /. إذا أجريت هذا التغيير، سيحتوي أول صفَّين فقط ضمن "مسموح به لـ /" على "نعم" في الجدول أعلاه.

لتغيير الإعداد التلقائي، يجب أن يضبط مشرف النظام قيمة السمة features.isSingleForwardSlashBlockingEnabled في مؤسستك على true. ويمكن لعملاء Cloud تقديم هذا الطلب إلى فريق دعم Apigee Edge.

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

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

  1. انتقِل إلى صفحة منتجات واجهة برمجة التطبيقات، كما هو موضّح سابقًا في هذا القسم.
  2. انقر على صف منتج واجهة برمجة التطبيقات الذي تريد تعديله.
  3. انقر على تعديل في صفحة منتج واجهة برمجة التطبيقات.
  4. عدِّل الحقول حسب الحاجة.

    يمكنك حذف الموارد التي أضفتها إلى منتج واجهة برمجة تطبيقات. قد تحتاج إلى إجراء ذلك إذا كان أحد الموارد لا يعمل بشكل صحيح أو يتطلّب المزيد من التطوير. عند حذف هذا المورد، لن يعود جزءًا من منتج واجهة برمجة التطبيقات. لن يتمكّن أي تطبيق يستخدم منتج واجهة برمجة التطبيقات من الوصول إلى المورد المحذوف. تتم إزالة الموارد المحذوفة من المنتج ولكن لا يتم حذفها من النظام، لذا يمكن أن تظل مستخدمة من قِبل منتجات أخرى.

  5. انقر على حفظ.

باستخدام Apigee Edge for Public Cloud، يحتفظ Edge بالكيانات التالية في ذاكرة التخزين المؤقت لمدة 180 ثانية على الأقل بعد الوصول إلى الكيانات.

  • رموز الدخول عبر OAuth وهذا يعني أنّ الرمز المميّز الذي تم إبطاله قد يظل صالحًا لمدة تصل إلى ثلاث دقائق، إلى أن تنتهي صلاحية الحدّ الأقصى لذاكرة التخزين المؤقت.
  • كيانات خدمة إدارة المفاتيح (KMS) (التطبيقات والمطوّرون ومنتجات واجهة برمجة التطبيقات)
  • السمات المخصّصة في رموز OAuth المميّزة وكيانات KMS

حذف منتج واجهة برمجة تطبيقات

قبل حذف منتج واجهة برمجة التطبيقات، يجب إلغاء تسجيل أو إلغاء ربط أي تطبيقات مطوّرين مرتبطة بالمنتج. ويمكنك إجراء ذلك من خلال حذف التطبيقات أو إبطال مفاتيح واجهة برمجة التطبيقات.

لحذف منتج واجهة برمجة تطبيقات:

  1. انتقِل إلى صفحة منتجات واجهة برمجة التطبيقات، كما هو موضّح سابقًا في هذا القسم.
  2. ضع المؤشر فوق منتج واجهة برمجة التطبيقات في القائمة.
  3. انقر على رمز الحذف.
  4. انقر على حذف لتأكيد عملية الحذف.