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

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

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

نظرة عامة على النشر عبر واجهة برمجة التطبيقات

تتكوّن عملية نشر واجهات برمجة التطبيقات في البوابة من خطوتَين:

1. اختَر منتج واجهة برمجة التطبيقات الذي تريد نشره على البوابة.
2. يمكنك عرض المستندات المرجعية لواجهة برمجة التطبيقات من لقطة لمستند OpenAPI أو مخطط GraphQL لتمكين مطوّري التطبيقات من التعرّف على واجهات برمجة التطبيقات. (لمزيد من المعلومات عن اللقطات، يُرجى الاطّلاع على المقالة ما هي اللقطة؟)

ما هو المحتوى المنشور على البوابة؟

عند نشر واجهة برمجة تطبيقات، يتم إجراء التعديلات التالية على البوابة تلقائيًا:

المستندات المرجعية لواجهة برمجة التطبيقات: تعتمد الواجهة المقدَّمة على ما إذا كنت ستنشر واجهة برمجة التطبيقات باستخدام مستند OpenAPI أو مخطط GraphQL. يُرجى الاطّلاع على:

• Smartالمستندات (OpenAPI)
• مستكشف GraphQL

إضافة رابط يؤدي إلى الصفحة المرجعية لواجهة برمجة التطبيقات إلى صفحة واجهات برمجة التطبيقات

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

• صورة معروضة لكل بطاقة واجهة برمجة تطبيقات
• الفئات المستخدَمة لوضع علامات على واجهات برمجة التطبيقات من أجل السماح للمطوّرين باكتشاف واجهات برمجة التطبيقات ذات الصلة في صفحة واجهات برمجة التطبيقات

Smartالمستندات (OpenAPI)

عند نشر واجهة برمجة تطبيقات باستخدام مستند OpenAPI، تتم إضافة المستندات المرجعية لـ Smart Docs API إلى البوابة.

يمكن للمطوّرين مراجعة الوثائق المرجعية لواجهة برمجة التطبيقات Smart Docs API واستخدام لوحة تجربة واجهة برمجة التطبيقات هذه لتقديم طلب بيانات من واجهة برمجة التطبيقات وعرض النتائج. يمكنك تجربة واجهة برمجة التطبيقات هذه مع نقاط نهاية غير آمنة أو نقاط نهاية آمنة باستخدام المصادقة الأساسية أو مفتاح واجهة برمجة التطبيقات أو مصادقة OAuth، وفقًا لطريقة الأمان المحدّدة في مستند OpenAPI. بالنسبة إلى بروتوكول OAuth، تتوفّر المسارات التالية: رمز التفويض وكلمة المرور وبيانات اعتماد العميل.

انقر على لتوسيع لوحة "تجربة واجهة برمجة التطبيقات هذه". تُتيح لك اللوحة الموسّعة عرض نماذج استدعاء curl والتعليمات البرمجية بتنسيقات مختلفة، مثل HTTP وPython وNode.js وغيرها، كما هو موضّح أدناه.

مستكشِف GraphQL

عند نشر واجهة برمجة تطبيقات باستخدام مخطّط GraphQL، تتم إضافة مستكشف GraphQL إلى البوابة. مستكشف GraphQL هو مساحة تفاعلية لتشغيل الاستعلامات مقابل واجهة برمجة التطبيقات الخاصة بك. يعتمد المستكشف على GraphiQL، وهو تطبيق مرجعي لـ GraphQL IDE الذي طورته مؤسسة GraphQL.

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

لمزيد من المعلومات عن GraphQL، يمكنك الاطّلاع على graphql.org.

ما المقصود باللقطة؟

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

عند نشر واجهة برمجة التطبيقات، يمكنك التقاط لقطة لمستند OpenAPI أو GraphQL لعرض المستندات المرجعية الخاصة بواجهة برمجة التطبيقات. تمثل هذه اللقطة نسخة معينة من المستند. إذا عدَّلت المستند، فقد تقرر التقاط لقطة أخرى للمستند كي تعكس آخر التغييرات في المستندات المرجعية لواجهة برمجة التطبيقات.

لمحة عن عناوين URL لمعاودة الاتصال

إذا كانت تطبيقاتك تتطلب عنوان URL لمعاودة الاتصال، كما هو الحال عند استخدام نوع منح رمز تفويض OAuth 2.0 (يُشار إليه غالبًا باسم "بروتوكول OAuth الثلاثي")، يمكنك أن تطلب من المطوّرين تحديد عنوان URL لمعاودة الاتصال عند تسجيل تطبيقاتهم. يحدِّد عنوان URL لمعاودة الاتصال عادةً عنوان URL لتطبيق تم تعيينه لتلقّي رمز تفويض نيابةً عن تطبيق العميل. ولمزيد من المعلومات، يُرجى الاطّلاع على تنفيذ نوع منح رمز التفويض.

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

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

إعداد خادم وكيل واجهة برمجة التطبيقات لإتاحة "تجربة واجهة برمجة التطبيقات هذه"

قبل نشر واجهات برمجة التطبيقات باستخدام مستند OpenAPI، سيتعين عليك تهيئة الخادم الوكيل لواجهة برمجة التطبيقات لدعم تقديم الطلبات من خلال لوحة تجربة واجهة برمجة التطبيقات هذه في الوثائق المرجعية لواجهة برمجة تطبيقات Smart Docs، كما يلي:

• إضافة إتاحة CORS إلى الخوادم الوكيلة لواجهة برمجة التطبيقات لتنفيذ الطلبات المشتركة المصدر من جهة العميل

  إنّ استدعاءات CORS هي آلية معيارية تسمح لاستدعاءات JavaScript XMLHttpRequest (XHR) التي يتم تنفيذها في صفحة ويب بالتفاعل مع الموارد الواردة من نطاقات غير أصلية. تُعدّ سياسة CORS هي حلّ يتم تنفيذه عادةً على "سياسة المصدر نفسه" التي يتم فرضها على جميع المتصفّحات.

• تعديل إعدادات الخادم الوكيل لواجهة برمجة التطبيقات إذا كنت تستخدم المصادقة الأساسية أو OAuth2

يلخّص الجدول التالي متطلبات ضبط الخادم الوكيل لواجهة برمجة التطبيقات لإتاحة لوحة "تجربة واجهة برمجة التطبيقات هذه" في المستندات المرجعية لواجهة برمجة تطبيقات Smart Docs استنادًا إلى إذن الوصول إلى المصادقة.

الوصول إلى المصادقة	متطلبات ضبط السياسة
لا شيء أو مفتاح واجهة برمجة التطبيقات	أضِف دعم CORS إلى الخادم الوكيل لواجهة برمجة التطبيقات. لتسهيل الأمر، يمكنك استخدام نموذج حل CORS المتوفّر في GitHub أو اتّبِع الخطوات الموضّحة في مقالة إضافة دعم سياسة CORS إلى خادم وكيل لواجهة برمجة التطبيقات.
المصادقة الأساسية	نفِّذ الخطوات التالية: أضِف دعم CORS إلى الخادم الوكيل لواجهة برمجة التطبيقات. لتسهيل الأمر، يمكنك استخدام نموذج حل CORS المتوفّر في GitHub أو اتّبِع الخطوات الموضّحة في مقالة إضافة دعم سياسة CORS إلى خادم وكيل لواجهة برمجة التطبيقات. في سياسة إضافة CORS AssignMessage، تأكَّد من أنّ عنوان Access-Control-Allow-Headers يتضمّن السمة authorization. مثلاً: <Header name="Access-Control-Allow-Headers"> origin, x-requested-with, accept, content-type, authorization </Header>
OAuth2	أضِف دعم CORS إلى الخادم الوكيل لواجهة برمجة التطبيقات. لتسهيل الأمر، يمكنك استخدام نموذج حل CORS المتوفّر في GitHub أو اتّبِع الخطوات الموضّحة في مقالة إضافة دعم سياسة CORS إلى خادم وكيل لواجهة برمجة التطبيقات. في سياسة إضافة CORS AssignMessage، تأكَّد من أنّ عنوان Access-Control-Allow-Headers يتضمّن السمة authorization. مثلاً: <Header name="Access-Control-Allow-Headers"> origin, x-requested-with, accept, content-type, authorization </Header> صحِّح السلوك غير المتوافق مع RFC في سياسة OAuth2. لتسهيل الأمر، يمكنك استخدام نموذج حل OAuth2 المتوفّر في GitHub أو تنفيذ الخطوات التالية: تأكَّد من ضبط العنصر <GrantType> في سياسة OAuth2 على request.formparam.grant_type (مَعلمة نموذج). لمزيد من المعلومات، يُرجى الاطّلاع على <GrantType>. تأكَّد من ضبط token_type في سياسة OAuth2 على Bearer، وليس على BearerToken التلقائية.

الاطّلاع على كتالوج واجهات برمجة التطبيقات

لعرض كتالوج واجهة برمجة التطبيقات: 1- اختَر نشر > البوابات واختَر البوابة. 2. انقر على كتالوج واجهة برمجة التطبيقات في الصفحة الرئيسية للبوابة. بدلاً من ذلك، يمكنك اختيار كتالوج واجهة برمجة التطبيقات في القائمة المنسدلة للبوابة في شريط التنقل العلوي.

تعرض علامة التبويب "واجهات برمجة التطبيقات" في كتالوج واجهات برمجة التطبيقات قائمة بواجهات برمجة التطبيقات التي تمت إضافتها إلى البوابة.

كما هو موضح في الشكل السابق، تتيح لك علامة التبويب "واجهات برمجة التطبيقات" إجراء ما يلي:

• عرض تفاصيل واجهات برمجة التطبيقات المتاحة في البوابة
• إضافة واجهة برمجة تطبيقات إلى البوابة
• يمكنك تعديل واجهة برمجة تطبيقات على البوابة من خلال تنفيذ مهمة واحدة أو أكثر من المهام التالية:
  • إدارة لقطة مستند مرتبط بأحد منتجات واجهة برمجة التطبيقات لتعديل المستندات المرجعية لواجهة برمجة التطبيقات
  • نشر واجهة برمجة تطبيقات أو إلغاء نشرها على البوابة
  • إدارة مستوى رؤية واجهة برمجة التطبيقات في البوابة:
  • إدارة عنوان URL لمعاودة الاتصال في واجهة برمجة تطبيقات
  • إدارة صورة بطاقة واجهة برمجة التطبيقات
  • وضع علامة على واجهة برمجة تطبيقات باستخدام الفئات
  • تعديل عنوان واجهة برمجة التطبيقات ووصفها
• إزالة واجهة برمجة تطبيقات من البوابة
• إدارة الفئات المستخدَمة لاكتشاف واجهات برمجة التطبيقات ذات الصلة
• تحديد المواصفات القديمة أو التي تم حذفها من متجر المواصفات بسرعة
• التعرّف سريعًا على واجهات برمجة التطبيقات "المعزولة" التي تمت إزالة منتج واجهة برمجة التطبيقات المرتبط بها من Edge، وإعادة إنشاء منتج واجهة برمجة التطبيقات أو حذف واجهة برمجة التطبيقات من البوابة

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

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

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

3. انقر على +.

   يظهر مربّع الحوار "إضافة منتج واجهة برمجة التطبيقات" إلى مربّع الحوار "الكتالوج".

4. اختَر منتج واجهة برمجة التطبيقات الذي تريد إضافته إلى البوابة.

5. انقر على التالي. يتم عرض صفحة تفاصيل واجهة برمجة التطبيقات.

6. ضبط محتوى المستندات المرجعية لواجهة برمجة التطبيقات ومستوى ظهوره على البوابة:

   الحقل	الوصف
   تاريخ النشر	اختَر تم النشر لنشر واجهة برمجة التطبيقات على البوابة. أزِل العلامة من مربّع الاختيار إذا لم تكن مستعدًا لنشر واجهة برمجة التطبيقات. يمكنك تغيير الإعداد لاحقًا، كما هو موضَّح في مقالة نشر واجهة برمجة تطبيقات أو إلغاء نشرها على البوابة.
   العنوان المعروض	عدِّل عنوان واجهة برمجة التطبيقات الظاهر في الكتالوج. وبشكلٍ تلقائي، يتم استخدام اسم المنتج في واجهة برمجة التطبيقات. يمكنك تغيير العنوان المعروض لاحقًا، كما هو موضَّح في تعديل العنوان المعروض والوصف.
   الوصف المعروض	عدِّل وصف واجهة برمجة التطبيقات الظاهر في الكتالوج. وبشكلٍ تلقائي، يتم استخدام وصف المنتج من واجهة برمجة التطبيقات. يمكنك تغيير وصف المعروض لاحقًا، كما هو موضح في تعديل العنوان والوصف المعروضين.
   أن يُطلب من المطوّرين تحديد عنوان URL لمعاودة الاتصال.	يمكنك تفعيل هذا الخيار إذا كنت تريد أن تطلب من مطوّري التطبيقات تحديد عنوان URL لمعاودة الاتصال. يمكنك إضافة عنوان URL لمعاودة الاتصال أو تعديله لاحقًا، كما هو موضَّح في إدارة عنوان URL لمعاودة الاتصال لواجهة برمجة التطبيقات.
   مستند واجهة برمجة التطبيقات	لاستخدام مستند OpenAPI: اختَر مستند OpenAPI. انقر على اختيار مستند. نفِّذ إحدى الخطوتَين التاليتَين: انقر على علامة التبويب مواصفاتي واختر مواصفات من متجر المواصفات. انقر على علامة التبويب تحميل ملف وحمِّل ملفًا. انقر على علامة التبويب استيراد من عنوان URL واستورِد مواصفات من عنوان URL. النقر على اختيار لاستخدام مخطّط GraphQL: اختَر مخطط GraphQL. انقر على اختيار مستند. انتقل إلى مخطط GraphQL وحدده. النقر على اختيار بدلاً من ذلك، يمكنك اختيار لا توجد مستندات وإضافة مستند لاحقًا بعد إضافة واجهة برمجة التطبيقات، كما هو موضَّح في قسم إدارة لقطة المستند.
   ظهور واجهة برمجة التطبيقات	إذا لم تسجّل نفسك في الإصدار التجريبي من ميزة إدارة شريحة الجمهور، حدِّد أحد الخيارات التالية: المستخدمون المجهولون للسماح لجميع المستخدمين بعرض واجهة برمجة التطبيقات. المستخدمون المسجّلون للسماح للمستخدمين المسجَّلين فقط بعرض واجهة برمجة التطبيقات. إذا سجّلت في الإصدار التجريبي لميزة إدارة الجمهور، حدِّد أحد الخيارات التالية: علني (مرئي لأي شخص) للسماح لجميع المستخدمين بعرض واجهة برمجة التطبيقات. المستخدمون الذين تمت مصادقتهم للسماح للمستخدمين المسجّلين فقط بعرض واجهة برمجة التطبيقات. شرائح الجمهور المحدّدة لاختيار شرائح جمهور معيّنة تريد التمكّن من عرضها على واجهة برمجة التطبيقات يمكنك إدارة إذن الوصول إلى الجمهور لاحقًا، كما هو موضَّح في مقالة إدارة إذن الوصول إلى واجهة برمجة التطبيقات في البوابة.
   الصورة المعروضة	لعرض صورة في بطاقة واجهة برمجة التطبيقات على صفحة واجهات برمجة التطبيقات، انقر على اختيار صورة. في مربع الحوار اختيار صورة، اختَر صورة حالية أو حمِّل صورة جديدة أو قدِّم عنوان URL لصورة خارجية، ثم انقر على اختيار. عايِن الصورة المصغّرة لواجهة برمجة التطبيقات وانقر على اختيار. ويمكنك إضافة صورة لاحقًا، على النحو الموضّح في إدارة الصورة لبطاقة واجهة برمجة التطبيقات. عند تحديد صورة باستخدام عنوان URL خارجي، لن يتم تحميلها إلى مواد العرض الخاصة بك. بالإضافة إلى ذلك، سيخضع تحميل الصورة في البوابة المدمجة لمدى توفّرها، وقد يتم حظره أو فرض قيود عليه بموجب سياسات أمان المحتوى.
   الفئات	أضِف الفئات التي ستتم إضافة علامة إلى واجهة برمجة التطبيقات عليها لتمكين مطوّري التطبيقات من اكتشاف واجهات برمجة التطبيقات ذات الصلة في صفحة واجهات برمجة التطبيقات. لتحديد فئة: اختَر فئة من القائمة المنسدلة. أضف فئة جديدة من خلال كتابة اسمها والضغط على Enter. ستتم إضافة الفئة الجديدة إلى صفحة "الفئات" وسيتم توفيرها عند إضافة واجهات برمجة تطبيقات أخرى أو تعديلها.

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

إدارة لقطة المستند

بعد نشر واجهة برمجة التطبيقات، يمكنك متى شئت أخذ لقطة جديدة من مستند OpenAPI أو GraphQL لتعديل المستندات المرجعية لواجهة برمجة التطبيقات التي تم نشرها على البوابة.

لإدارة لقطة المستند:

1. الوصول إلى كتالوج واجهة برمجة التطبيقات
2. انقر على علامة التبويب واجهات برمجة التطبيقات، إذا لم تكن محددة من قبل.
3. انقر على صف واجهة برمجة التطبيقات التي تريد تعديلها.
4. التحقّق من حالة اللقطة وإذا كانت قديمة، يتم عرض الرسالة التالية:
5. انقر على
6. نفِّذ إحدى المهام التالية:
   • لإعادة تحميل لقطة من مستند OpenAPI أصبح قديمًا، انقر على إعادة تحميل اللقطة.
   • لتغيير المستند المستخدَم لإنشاء وثائق واجهة برمجة التطبيقات، انقر على اختيار مستند ضِمن وثائق واجهة برمجة التطبيقات واختَر المستند الجديد.
7. انقر على حفظ.

يتم عرض الوثائق المرجعية لواجهة برمجة التطبيقات من المستند وإضافتها إلى صفحة مرجع واجهة برمجة التطبيقات. يتم تحديث حالة اللقطة إلى الحالة الحالية:

نشر واجهة برمجة تطبيقات أو إلغاء نشرها على البوابة

لنشر واجهة برمجة تطبيقات أو إلغاء نشرها على البوابة:

1. الوصول إلى كتالوج واجهة برمجة التطبيقات
2. انقر على علامة التبويب واجهات برمجة التطبيقات، إذا لم تكن محددة من قبل.
3. انقر على صف واجهة برمجة التطبيقات التي تريد تعديلها.
4. انقر على
5. ضمن تفاصيل واجهة برمجة التطبيقات، اختَر المنشورة (المُدرَجة في الكتالوج) أو ألغِ اختيارها لنشر واجهة برمجة التطبيقات أو إلغاء نشرها على البوابة، على التوالي.
6. انقر على حفظ.

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

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

• علني (مرئي للجميع)
• المستخدمون الذين تمت المصادقة عليهم
• شرائح الجمهور المحددة (إذا كنت قد سجّلت في الإصدار التجريبي من ميزة إدارة شريحة الجمهور)

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

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

6. اختَر إعداد مستوى العرض. إذا كنت سجّلت في الإصدار التجريبي من ميزة شرائح الجمهور، حدِّد أحد الخيارات التالية:

   • علنية (مرئية لأي شخص) للسماح لجميع المستخدمين بعرض الصفحة.
   • المستخدمون الذين تمت مصادقتهم للسماح للمستخدمين المسجّلين فقط بعرض الصفحة.
   • الجماهير المختارة لاختيار شرائح جمهور معيّنة تريد التمكّن من عرضها على الصفحة يُرجى الاطّلاع على المقالة إدارة شرائح الجمهور في البوابة.
   بخلاف ذلك، حدِّد أحد الخيارات التالية:
   • المستخدمون المجهولون للسماح لجميع المستخدمين بعرض الصفحة.
   • المستخدمون المسجّلون للسماح للمستخدمين المسجَّلين فقط بعرض الصفحة.

7. انقر على إرسال.

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

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

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

1. الوصول إلى كتالوج واجهة برمجة التطبيقات
2. انقر على علامة التبويب واجهات برمجة التطبيقات، إذا لم تكن محددة من قبل.
3. انقر على صف واجهة برمجة التطبيقات التي تريد تعديلها.
4. انقر على
5. ضمن تفاصيل واجهة برمجة التطبيقات، اختَر المنشورة (المُدرَجة في الكتالوج) أو ألغِ اختيارها لنشر واجهة برمجة التطبيقات أو إلغاء نشرها على البوابة، على التوالي.
6. انقر على حفظ.

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

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

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

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

5. ضمن تفاصيل واجهة برمجة التطبيقات:

   • انقر على اختيار صورة لتحديد صورة أو تحميلها إذا لم يتم اختيار صورة في الوقت الحالي.
   • انقر على تغيير الصورة لتحديد صورة مختلفة أو تحميلها.
   • انقر على x في الصورة لإزالته.

   عند تحديد صورة، حدِّد صورة تتضمّن عنوان URL خارجيًا يُستخدم لعنصر الكتالوج أو مسار ملف لملفات الصور المخزّنة في البوابة، مثل /files/book-tree.jpg. عند تحديد عنوان URL لصورة خارجية، لن يتم تحميل الصورة إلى مواد العرض الخاصة بك. بالإضافة إلى ذلك، سيخضع تحميل الصورة في البوابة المدمجة لمدى توفّرها، وقد يتم حظره أو فرض قيود عليه بموجب سياسات أمان المحتوى.

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

وضع علامة على واجهة برمجة تطبيقات باستخدام الفئات

وضع علامة على واجهة برمجة تطبيقات باستخدام الفئات بإحدى الطرق التالية:

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

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

1. الوصول إلى كتالوج واجهة برمجة التطبيقات
2. انقر على علامة التبويب واجهات برمجة التطبيقات، إذا لم تكن محددة من قبل.
3. انقر على صف واجهة برمجة التطبيقات التي تريد تعديلها.
4. انقر على
5. انقر داخل حقل الفئات ونفِّذ إحدى الخطوات التالية:
   • اختَر فئة من القائمة المنسدلة.
   • أضف فئة جديدة من خلال كتابة اسمها والضغط على Enter. ستتم إضافة الفئة الجديدة إلى صفحة "الفئات" وسيتم توفيرها عند إضافة واجهات برمجة تطبيقات أخرى أو تعديلها.
6. كرِّر هذه الخطوة لوضع علامة على واجهة برمجة التطبيقات في المزيد من الفئات.
7. انقر على حفظ.

تعديل العنوان والوصف المعروضَين

لتعديل عنوان العرض ووصفه:

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

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

لإزالة واجهة برمجة تطبيقات من البوابة، يُرجى اتّباع الخطوات التالية:

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

إدارة الفئات المُستخدَمة لاكتشاف واجهات برمجة التطبيقات ذات الصلة

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

استكشاف صفحة "الفئات"

لعرض صفحة "الفئات":

1. اختَر نشر > البوابات واختَر البوابة.
2. انقر على كتالوج واجهة برمجة التطبيقات في الصفحة الرئيسية للبوابة.

   بدلاً من ذلك، يمكنك اختيار كتالوج واجهة برمجة التطبيقات في القائمة المنسدلة للبوابة في شريط التنقل العلوي.

3. انقر على علامة التبويب الفئات.

تعرض علامة تبويب "الفئات" في كتالوج واجهة برمجة التطبيقات قائمة بالفئات المحدّدة لمدخلك.

وكما هو موضح في الشكل السابق، تتيح لك صفحة واجهات برمجة التطبيقات إجراء ما يلي:

• عرض الفئات وواجهات برمجة التطبيقات التي تم وضع علامة عليها
• إضافة فئة
• تعديل فئة
• حذف فئة
• يمكنك إدارة واجهات برمجة التطبيقات المنشورة على البوابة. يمكنك الاطّلاع على استكشاف كتالوج واجهة برمجة التطبيقات.

إضافة فئة

أضِف فئة بإحدى الطرق التالية:

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

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

لإضافة فئة يدويًا:

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

تعديل فئة

لتعديل فئة:

1. ادخل إلى صفحة "الفئات".
2. انقر على
3. عدِّل اسم الفئة.
4. إضافة علامات واجهة برمجة التطبيقات أو إزالتها
5. انقر على حفظ.

حذف فئة

عند حذف فئة، يتم أيضًا حذف جميع علامات واجهة برمجة التطبيقات المتعلقة بتلك الفئة.

لحذف فئة:

1. ادخل إلى صفحة "الفئات".
2. ضع مؤشر الماوس فوق الفئة التي تريد تعديلها لعرض قائمة الإجراءات.
3. انقر على
4. عدِّل اسم الفئة.
5. إضافة واجهات برمجة التطبيقات أو إزالتها
6. انقر على حفظ.

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

تقدّم الأقسام التالية معلومات لمساعدتك في تحديد وحلّ مشاكل معيّنة في واجهات برمجة التطبيقات المنشورة.

خطأ: تعذّر استرجاع الخطأ الذي ظهر عند استخدام تجربة واجهة برمجة التطبيقات هذه.

عند استخدام واجهة برمجة التطبيقات هذه، في حال ظهور خطأ "TypeError: Failed to fetch"، يجب مراعاة الأسباب والحلول المحتملة التالية:

• بالنسبة إلى أخطاء المحتوى المختلط، قد يكون سبب الخطأ مشكلة معروفة في واجهة المستخدم الأساسية. أحد الحلول الممكنة هو التأكّد من تحديد HTTPS قبل HTTP في تعريف schemes في مستند OpenAPI. مثلاً:

  schemes:
     - https
     - http
  

• بالنسبة إلى أخطاء فرض قيود على مشاركة الموارد المتعدّدة المصادر (CORS)، تأكَّد من أنّ سياسة مشاركة الموارد المتعدّدة المصادر (CORS) متوافقة مع الخوادم الوكيلة لواجهة برمجة التطبيقات. إنّ سياسة مشاركة الموارد المتعددة المصادر (CORS) هي آلية معيارية تتيح إرسال الطلبات المشتركة المصدر من جهة العميل. يُرجى الاطِّلاع على ضبط الخادم الوكيل لواجهة برمجة التطبيقات لإتاحة تجربة واجهة برمجة التطبيقات هذه.

خطأ: يحتوي العنوان 'Access-Control-Allow-Origin' على قيم متعددة '*, *'، ولكن يُسمح باستخدام قيمة واحدة فقط.

عند استخدام واجهة برمجة التطبيقات هذه، قد تظهر لك رسالة الخطأ التالية في حال توفّر عنوان Access-Control-Allow-Origin:

The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

لتصحيح هذا الخطأ، عليك تعديل سياسة AssignMessage لاستخدام <Set> لضبط عناوين CORS بدلاً من <Add>، كما هو موضَّح في المقتطف أدناه. للمزيد من المعلومات، يُرجى الاطّلاع على المقالة في "المنتدى".

<AssignMessage async="false" continueOnError="false" enabled="true" name="add-cors">
    <DisplayName>Add CORS</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="Access-Control-Allow-Origin">{request.header.origin}</Header>
            <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept, content-type, authorization</Header>
            <Header name="Access-Control-Max-Age">3628800</Header>
            <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

خطأ: غير مسموح بحقل عنوان الطلب

عند استخدام واجهة برمجة التطبيقات هذه، إذا ظهر لك خطأ Request header field not allowed، كما هو الحال في المثال أدناه، قد تحتاج إلى تعديل العناوين المتوافقة في سياسة CORS. مثلاً:

Access to XMLHttpRequest ... has been blocked by CORS policy: Request header field
content-type is not allowed by Access-Control-Allow-Headers in preflight response

في هذا المثال، عليك إضافة العنوان content-type إلى القسم "Access-Control-Allow-Headers" في سياسة assignMessage في CORS، كما هو موضّح في المقالة إرفاق سياسة إضافة CORS إلى خادم وكيل جديد لواجهة برمجة التطبيقات.

خطأ: تم رفض الوصول عند طلب خادم وكيل لواجهة برمجة التطبيقات باستخدام OAuth2.

تعرض سياسة OAuthV2 في Apigee استجابة رمز مميّز تحتوي على خصائص معيَّنة غير متوافقة مع RFC. على سبيل المثال، ستعرض السياسة رمزًا مميزًا بالقيمة BearerToken، بدلاً من القيمة المتوقعة المتوافقة مع RFC Bearer. يمكن أن تؤدي استجابة token_type غير الصالحة هذه إلى ظهور الخطأ Access denied عند استخدام واجهة برمجة التطبيقات هذه.

لحلّ هذه المشكلة، يمكنك إنشاء سياسة JavaScript أو AssignMessage لتحويل مخرجات السياسة إلى تنسيق متوافق. لمزيد من المعلومات، راجِع السلوك غير المتوافق مع RFC.