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

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

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

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

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

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

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

Edge

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

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

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

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

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

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

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

  1. سجّل الدخول إلى http://ms-ip:9000، حيث ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
  2. اختَر نشر >. المنتجات:

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

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

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

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

  1. الوصول إلى صفحة منتجات واجهة برمجة التطبيقات كما هو موضّح سابقًا في هذا القسم.
  2. انقر على +منتج واجهة برمجة التطبيقات.
  3. أدخِل تفاصيل المنتج الخاصة بمنتج واجهة برمجة التطبيقات.
    الحقل الوصف
    الاسم الاسم الداخلي لمنتج واجهة برمجة التطبيقات. ولا يمكنك تعديل الاسم بعد إنشاء منتج واجهة برمجة التطبيقات. لا تحدّد رموزًا خاصة في الاسم.
    الاسم المعروض الاسم المعروض لمنتج واجهة برمجة التطبيقات. يُستخدم الاسم المعروض في واجهة المستخدم ويمكنك تعديله في أي وقت. وإذا لم يتم تحديدها، سيتم استخدام قيمة "الاسم". يتم ملء هذا الحقل تلقائيًا باستخدام قيمة "Name" (الاسم). يمكنك تعديل محتواها أو حذفه. يمكن أن يتضمّن الاسم المعروض رموزًا خاصة.
    الوصف وصف لمنتج واجهة برمجة التطبيقات.
    البيئة البيئات التي سيسمح منتج واجهة برمجة التطبيقات بالوصول إليها. على سبيل المثال، 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 Adapter.

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

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

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

تهيئة سلوك مسار مورد '/'، '/*'، و "/**"

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

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

/v1/weatherapikey

نعم

لا

لا

لا

N

/v1/weatherapikey/

نعم

لا

لا

لا

N

/v1/weatherapikey/1

نعم

نعم

نعم

لا

N

/v1/weatherapikey/1/

نعم

نعم

نعم

لا

N

/v1/weatherapikey/1/2

نعم

لا

نعم

لا

N

/v1/weatherapikey/1/2/

نعم

لا

نعم

نعم

N

/v1/weatherapikey/1/2/3/

نعم

لا

نعم

نعم

نعم

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

نعم

لا

نعم

لا

N

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

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

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

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

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

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

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

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

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

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

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

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

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

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