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

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

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

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

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

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

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

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

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

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

   الحقل	الوصف
   الاسم	الاسم الداخلي لمنتج واجهة برمجة التطبيقات. ولا يمكنك تعديل الاسم بعد إنشاء منتج واجهة برمجة التطبيقات. لا تحدّد أحرفًا خاصة في الاسم.
   الاسم المعروض	الاسم المعروض لمنتج واجهة برمجة التطبيقات يُستخدم الاسم المعروض في واجهة المستخدم ويمكنك تعديله في أي وقت. إذا لم يتم تحديد ذلك، سيتم استخدام قيمة "الاسم". يتم ملء هذا الحقل تلقائيًا باستخدام قيمة "الاسم"، ويمكنك تعديل محتواه أو حذفه. يمكن أن يتضمّن الاسم المعروض رموزًا خاصة.
   الوصف	وصف منتج واجهة برمجة التطبيقات.
   البيئة	البيئات التي سيسمح منتج واجهة برمجة التطبيقات بها بالوصول إليها. على سبيل المثال، test أو prod.
   إذن الوصول	مستوى الوصول. للحصول على التفاصيل، يُرجى الاطّلاع على مستوى الوصول.
   الموافقة تلقائيًا على طلبات الوصول	يمكنك تفعيل الموافقة التلقائية على الطلبات الرئيسية لمنتج واجهة برمجة التطبيقات هذا من أي تطبيق. ولطلب الموافقة اليدوية على المفاتيح، أوقِف هذا الخيار. يُرجى الاطّلاع على تسجيل التطبيقات وإدارة مفاتيح واجهة برمجة التطبيقات (UI) ومفاتيح تطبيقات مطوّري البرامج (API).
   الحصة	حدّ الحصة التي تريد الإشارة إليها من سياسات الحصص. لا يؤدي إدخال قيمة للحصة إلى فرض قيود تلقائيًا على عدد المكالمات التي يمكن إجراؤها من خلال المنتج. يجب أن تتضمّن الخوادم الوكيلة لواجهة برمجة التطبيقات التي يشير إليها المنتج سياسة الحصة لفرض الحصة. لمزيد من المعلومات، يُرجى الاطّلاع على الحصص.
   نطاقات 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، يمكنك تجاهل هذا الإعداد. لمزيد من المعلومات، يُرجى الاطّلاع على دليل العمليات لمحوِّل Apigee Envoy.

6. (اختياري) استخدِم قسم السمات المخصّصة لإضافة ما يصل إلى 18 سمة مخصّصة إلى منتج واجهة برمجة التطبيقات.

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

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

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

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

عنوان URI للطلب	مسموح بها لـ /	مسموح به لـ /*	مسموح به لـ /**	مسموح به لـ /*/2/**	مسموح به لـ /*/2/*
/v1/weatherapikey	Y	لا	لا	لا	N
/v1/weatherapikey/	Y	لا	لا	لا	N
/v1/weatherapikey/1	Y	Y	نعم	لا	N
/v1/weatherapikey/1/	Y	Y	نعم	لا	N
/v1/weatherapikey/1/2	Y	لا	نعم	لا	N
/v1/weatherapikey/1/2/	Y	لا	Y	نعم	N
/v1/weatherapikey/1/2/3/	Y	لا	Y	Y	Y
/v1/weatherapikey/1/a/2/3/	Y	لا	نعم	لا	N

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

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

لتغيير السمة التلقائية، على مشرف النظام ضبط قيمة السمة 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. انقر على حذف لتأكيد عملية الحذف.