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

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

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

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

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

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

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

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

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

• SmartDocs (OpenAPI)
• مستكشف GraphQL

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

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

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

SmartDocs (OpenAPI)

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

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

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

مستكشف GraphQL

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

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

لمزيد من المعلومات عن GraphQL، انتقِل إلى الموقع الإلكتروني graphql.org.

ما هي اللقطة؟

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

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

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

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

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

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

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

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

• إضافة دعم 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. انقر على Next (التالي).
   يتم عرض صفحة تفاصيل واجهة برمجة التطبيقات.

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

   الحقل	الوصف
   تاريخ النشر	اختَر تم النشر لنشر واجهة برمجة التطبيقات على بوابتك. أزِل العلامة من مربّع الاختيار إذا لم تكن مستعدًا لنشر واجهة برمجة التطبيقات. يمكنك تغيير الإعداد لاحقًا، كما هو موضَّح في مقالة نشر أو إلغاء نشر واجهة برمجة تطبيقات على بوابتك.
   العنوان المعروض	عدِّل عنوان واجهة برمجة التطبيقات الظاهر في الكتالوج. بشكل افتراضي، يتم استخدام اسم منتج واجهة برمجة التطبيقات. يمكنك تغيير العنوان المعروض لاحقًا، كما هو موضَّح في تعديل العنوان والوصف المعروضَين.
   الوصف المعروض	عدِّل وصف واجهة برمجة التطبيقات الظاهر في الكتالوج. بشكل تلقائي، يتم استخدام وصف المنتج من واجهة برمجة التطبيقات. يمكنك تغيير وصف العرض لاحقًا، كما هو موضَّح في تعديل العنوان والوصف المعروضَين.
   مطالبة المطوّرين بتحديد عنوان URL لمعاودة الاتصال	يمكنك تفعيل هذا الخيار إذا كنت تريد أن تطلب من مطوّري التطبيقات تحديد عنوان URL لمعاودة الاتصال. يمكنك إضافة عنوان URL لمعاودة الاتصال أو تعديله لاحقًا، كما هو موضَّح في إدارة عنوان URL لمعاودة الاتصال لواجهة برمجة التطبيقات.
   مستند واجهة برمجة التطبيقات	لاستخدام مستند OpenAPI: اختَر مستند OpenAPI. انقر على اختيار مستند. نفِّذ إحدى الخطوات التالية: انقر على علامة التبويب المواصفات الخاصة بي واختر مواصفات من متجر المواصفات. انقر على علامة التبويب تحميل ملف وحمّل ملفًا. انقر على علامة التبويب استيراد من عنوان URL استورِد مواصفات من عنوان URL. النقر على اختيار لاستخدام مخطّط GraphQL: اختر مخطط GraphQL. انقر على اختيار مستند. انتقِل إلى مخطط GraphQL واختَره. النقر على اختيار وبدلاً من ذلك، يمكنك اختيار لا توجد مستندات وإضافة مستند لاحقًا بعد إضافة واجهة برمجة التطبيقات، كما هو موضّح في القسم إدارة لقطة المستند.
   مستوى ظهور واجهة برمجة التطبيقات	إذا لم تسجَّل في الإصدار التجريبي من ميزة إدارة الجمهور، حدِّد أحد الخيارات التالية: المستخدمون المجهولون للسماح لجميع المستخدمين بعرض واجهة برمجة التطبيقات. المستخدمون المسجّلون للسماح للمستخدمين المسجَّلين فقط بعرض واجهة برمجة التطبيقات. إذا كنت قد سجّلت في الإصدار التجريبي من ميزة إدارة الجمهور، حدِّد أحد الخيارات التالية: علني (مرئي لأي شخص) للسماح لجميع المستخدمين بعرض واجهة برمجة التطبيقات. المستخدمون الذين تمت المصادقة عليهم للسماح للمستخدمين المسجَّلين فقط بعرض واجهة برمجة التطبيقات. شرائح الجمهور المحددة لاختيار شرائح جمهور معيّنة تريد التمكّن من عرضها في واجهة برمجة التطبيقات. ويمكنك إدارة إذن الوصول إلى الجمهور لاحقًا، كما هو موضَّح في إدارة إذن الوصول إلى واجهة برمجة التطبيقات في البوابة.
   الصورة المعروضة	لعرض صورة على بطاقة واجهة برمجة التطبيقات في صفحة واجهات برمجة التطبيقات، انقر على اختيار صورة. في مربّع الحوار اختيار صورة، اختَر صورة حالية أو حمِّل صورة جديدة أو قدِّم عنوان 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 في الصورة لإزالتها.

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.