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

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

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

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

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

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

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

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

لإضافة منتج 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 بقيمة "صحيح" أو "خطأ". في مسار خادم وكيل API، يمكنك التحقّق من قيمة السمة deprecated الخاصة بمنتج API (على سبيل المثال، باستخدام المتغيّر verifyapikey.{policy_name}.apiproduct.deprecated المتاح تلقائيًا بعد إنشاء السمة المخصّصة). إذا كانت قيمته صحيحة (متوقّف نهائيًا)، يمكنك طرح خطأ باستخدام سياسة Raise Fault.

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

إعداد سلوك مسار المورد الذي يتضمّن "/" و"/*" و"/**"

يوضّح الجدول التالي السلوك التلقائي لأحد منتجات واجهة برمجة التطبيقات (API) لمسارات موارد مختلفة. في هذا المثال، يحتوي خادم وكيل واجهة برمجة التطبيقات على مسار أساسي هو /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/	نعم	لا	نعم	لا	لا

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

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

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

تعديل منتج API

لتعديل منتج API، اتّبِع الخطوات التالية:

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

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

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

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

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

حذف منتج API

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

لحذف منتج API، اتّبِع الخطوات التالية:

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