تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

مستكشف GraphQL

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

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

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

مستكشف GraphQL في البوابة

ما المقصود بالنبذة؟

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

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

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

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

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

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

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

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

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

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

الوصول للمصادقة متطلبات ضبط السياسة

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

المصادقة الأساسية

الوصول للمصادقة	متطلبات ضبط السياسة
بدون مفتاح أو مفتاح واجهة برمجة التطبيقات	يمكنك إضافة دعم 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` التلقائي.

نفِّذ الخطوات التالية:

يمكنك إضافة دعم 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، ويمكنك إعادة إنشاء منتج واجهة برمجة التطبيقات أو حذف واجهة برمجة التطبيقات من البوابة

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

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

الوصول إلى كتالوج واجهة برمجة التطبيقات
انقر على علامة التبويب واجهات برمجة التطبيقات إذا لم يكن قد سبق اختيارها.
انقر على +.

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

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

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

انقر على حفظ.

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

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

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

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

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

الرمز والرسالة يشيران إلى أنّ اللقطة حالية

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ملاحظة: تعرض بطاقة المنتج من واجهة برمجة التطبيقات صورًا بدقة 320×192 بكسل أو بنسبة عرض إلى ارتفاع. لـ 5×3. يجب تنسيق صورك بهذا الحجم لتجنُّب تشويه الصور.
انقر على حفظ.

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

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

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

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

الوصول إلى كتالوج واجهة برمجة التطبيقات
انقر على علامة التبويب واجهات برمجة التطبيقات إذا لم يكن قد سبق اختيارها.
انقر على صف واجهة برمجة التطبيقات التي تريد تعديلها.
انقر على .
انقر داخل الحقل الفئات ونفِّذ إحدى الخطوات التالية:
- اختَر فئة من القائمة المنسدلة.
- أضف فئة جديدة عن طريق كتابة اسمها والضغط على Enter. ستتم إضافة الفئة الجديدة إلى صفحة "الفئات" وسيتم توفيرها عند إضافة واجهات برمجة تطبيقات أخرى أو تعديلها.
كرِّر هذه الخطوات لوضع علامة على واجهة برمجة التطبيقات في المزيد من الفئات.
انقر على حفظ.

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

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

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

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

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

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

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

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

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

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

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

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

علامة تبويب "الفئات" التي تعرض اسم الفئة والأسماء والعدد الإجمالي لواجهات برمجة التطبيقات التي تم تعيينها

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

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

إضافة فئة

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

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

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

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

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

تعديل فئة

لتعديل فئة:

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

حذف فئة

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

لحذف فئة:

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

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

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

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

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

بالنسبة إلى أخطاء المحتوى المختلَط، قد يكون السبب في الخطأ مشكلة معروفة في واجهة المستخدم بطريقة swagger-ui. أحد الحلول الممكنة هي التأكّد من تحديد 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 في سياسة CORS AssignMessage، كما هو موضَّح في. إرفاق سياسة "إضافة سياسة مشاركة الموارد المتعددة المصادر (CORS)" إلى خادم وكيل جديد لواجهة برمجة التطبيقات

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

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

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