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

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

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

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

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

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

ما الذي يتم نشره على المنصة؟

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

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

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

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

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

‫SmartDocs‏ (OpenAPI)

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

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

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

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

لوحة "تجربة واجهة برمجة التطبيقات هذه" الموسّعة

GraphQL Explorer

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

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

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

‫GraphQL Explorer في البوابة

ما هي اللقطة؟

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

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

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

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

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

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

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

قبل نشر واجهات برمجة التطبيقات باستخدام مستند OpenAPI، عليك ضبط الخادم الوكيل لواجهة برمجة التطبيقات لإتاحة تقديم الطلبات في لوحة تجربة واجهة برمجة التطبيقات هذه في مستندات مرجع واجهة برمجة التطبيقات في SmartDocs، على النحو التالي:

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

    ‫CORS هي آلية عادية تتيح لطلبات JavaScript XMLHttpRequest (XHR) التي يتم تنفيذها في صفحة ويب التفاعل مع الموارد من نطاقات غير المصدر. تُعدّ مشاركة الموارد المتعدّدة المصادر (CORS) حلاً شائعًا لسياسة المصدر المشترك التي تفرضها جميع المتصفحات.

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

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

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

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

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

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

استخدِم واجهة المستخدم أو الأمر curl لعرض واجهات برمجة التطبيقات في البوابة.

واجهة المستخدِم

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

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

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

علامة التبويب &quot;واجهات برمجة التطبيقات&quot; التي تعرض معلومات عن واجهات برمجة التطبيقات، بما في ذلك الاسم والوصف ومستوى العرض والفئات والمواصفات المرتبطة ووقت التعديل

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

curl

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

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN"

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • ACCESS_TOKEN برمز المصادقة المستخدَم للوصول إلى واجهة برمجة تطبيقات Apigee Edge. لمزيد من المعلومات عن المصادقة والرموز المميّزة، يُرجى الاطّلاع على مصادقة الوصول إلى Edge API.

يُرجى الاطّلاع على ملاحظات حول تقسيم الصفحات للحصول على تعليمات حول استخدام تقسيم الصفحات في حمولة الاستجابة.

حمولة الاستجابة:

{
  "status": "success",
  "message": "one page of apidocs returned",
  "data": [
    {
      "id": 622759,
      "siteId": "my-org-myportal",
      "title": "Test",
      "description": "",
      "published": false,
      "visibility": false,
      "apiId": "apiproducttest18",
      "apiProductName": "apiproduct_test18",
      "edgeAPIProductName": "apiproduct_test18",
      "specId": null,
      "specContent": null,
      "specTitle": null,
      "snapshotExists": false,
      "snapshotModified": null,
      "modified": 1724144471000,
      "anonAllowed": false,
      "imageUrl": null,
      "snapshotState": null,
      "requireCallbackUrl": false,
      "categoryIds": [],
      "specFormat": null,
      "specModified": null,
      "snapshotOutdated": false,
      "snapshotSourceMissing": false,
      "graphqlSchema": null,
      "graphqlEndpointUrl": null,
      "graphqlSchemaDisplayName": null,
      "grpcFileName": null,
      "grpcZipContent": null
    }
  ],
  "code": null,
  "request_id": "1452867334",
  "error_code": null,
  "next_page_token": ""
}

المكان:

  • ‫modified: الوقت الذي تم فيه آخر تعديل على عنصر الكتالوج بالمللي ثانية منذ تاريخ بدء حساب الفترة مثلاً: 1698165480000
  • ‫id: معرّف السلعة في الكتالوج مثلاً: 399668

ملاحظات حول تقسيم الصفحات:

  • حجم الصفحة: استخدِم pageSize لتحديد عدد عناصر القائمة التي سيتم عرضها في صفحة واحدة. القيمة التلقائية هي 25، والحد الأقصى هو 100. إذا كانت هناك صفحات إضافية، تتم تعبئة nextPageToken برمز مميّز:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE" \
       -H "Authorization: Bearer ACCESS_TOKEN"
    

    استبدال:

    • ‫PAGE_SIZE مع عدد عناصر القائمة التي سيتم عرضها في صفحة واحدة. على سبيل المثال، 10.

    حمولة الاستجابة:

    {
      "status": "success",
      "message": "one page of apidocs returned",
      "data": [
        {
          "id": 638007,
          "siteId": "tsnow-mint-liztest",
          "title": "Testing",
          "description": "",
          "published": false,
          "visibility": false,
          "apiId": "testcatalog",
          "apiProductName": "testcatalog",
          "edgeAPIProductName": "testcatalog",
          "specId": "Petstore",
          "specContent": null,
          "specTitle": null,
          "snapshotExists": true,
          "snapshotModified": 1726508367000,
          "modified": 1728582504000,
          "anonAllowed": false,
          "imageUrl": null,
          "snapshotState": "OK_SUBMITTED",
          "requireCallbackUrl": false,
          "categoryIds": [],
          "specFormat": "YAML",
          "specModified": null,
          "snapshotOutdated": false,
          "snapshotSourceMissing": false,
          "graphqlSchema": null,
          "graphqlEndpointUrl": null,
          "graphqlSchemaDisplayName": null,
          "grpcFileName": null,
          "grpcZipContent": null
        }
      ],
      "code": null,
      "request_id": "1068810934",
      "error_code": null,
      "next_page_token": ""
    }
    

  • الرمز المميّز للصفحة: استخدِم pageToken لاسترداد الصفحات اللاحقة عندما يكون هناك أكثر من صفحة واحدة:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN" \
          -H "Authorization: Bearer ACCESS_TOKEN"
    

    استبدال:

    • ‫PAGE_SIZE مع عدد عناصر القائمة التي سيتم عرضها في صفحة واحدة. على سبيل المثال، 10.
    • ‫PAGE_TOKEN مع القيمة nextPageToken على سبيل المثال: 7zcqrin9l6xhi4nbrb9.

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

استخدِم واجهة المستخدم أو الأمر curl لإضافة واجهات برمجة التطبيقات إلى بوابتك:

واجهة المستخدِم

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

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

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

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

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

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

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

    لاستخدام مستند OpenAPI:

    1. اختَر مستند OpenAPI.
    2. انقر على اختيار مستند.
    3. نفِّذ إحدى الخطوات التالية:
      • انقر على علامة التبويب المواصفات الخاصة بي واختَر مواصفات من متجر المواصفات.
      • انقر على علامة التبويب تحميل ملف وحمِّل ملفًا.
      • انقر على علامة التبويب الاستيراد من عنوان URL واستورِد مواصفات من عنوان URL.
    4. انقر على اختيار.

    لاستخدام مخطّط GraphQL:

    1. اختَر مخطط GraphQL.
    2. انقر على اختيار مستند.
    3. انتقِل إلى مخطّط GraphQL واختَره.
    4. انقر على اختيار.

    بدلاً من ذلك، يمكنك اختيار No documentation (بلا مستندات) وإضافة مستند لاحقًا بعد إضافة واجهة برمجة التطبيقات، كما هو موضّح في إدارة اللقطة من المستند.

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

    إذا لم تكن قد سجّلت في الإصدار التجريبي من ميزة إدارة الجمهور، حدِّد أحد الخيارات التالية:

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

    إذا كنت قد سجّلت في الإصدار التجريبي من ميزة إدارة الجمهور، حدِّد أحد الخيارات التالية:

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

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

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

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

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

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

curl

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

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": "IMAGE_URL",
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
         "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE,
        "apiProductName": "API_PRODUCT"
    }'

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • ACCESS_TOKEN برمز المصادقة المستخدَم للوصول إلى واجهة برمجة تطبيقات Apigee Edge. لمزيد من المعلومات عن المصادقة والرموز المميّزة، يُرجى الاطّلاع على مصادقة الوصول إلى Edge API.
  • ‫TITLE مع العنوان المعروض مثلاً: Hello World 2
  • ‫DESCRIPTION مع الوصف المعروض على سبيل المثال: Simple hello world example.
  • ‫ANON_TRUE_OR_FALSE مع true أو false (الإعداد التلقائي)، حيث تعني true أنّ واجهة برمجة التطبيقات هذه متاحة للجميع ويمكن الاطّلاع عليها بشكل مجهول الهوية، وإلا يمكن للمستخدمين المسجّلين فقط الاطّلاع عليها.
  • IMAGE_URL بعنوان URL لصورة خارجية مستخدَمة لعنصر الكتالوج، أو مسار ملف لملفات الصور المخزَّنة في المنصة، على سبيل المثال، /files/book-tree.jpg. عند تحديد عنوان URL لصورة خارجية، لن يتم تحميل الصورة إلى مواد العرض، وسيخضع تحميل الصورة في البوابة المدمجة لمدى توفّرها، وقد يتم حظرها أو تقييدها بموجب سياسات أمان المحتوى.
  • CALLBACK_TRUE_OR_FALSE مع true أو false (تلقائي)، حيث يتطلب true من مستخدم البوابة إدخال عنوان URL عند إدارة التطبيق.
  • ‫CATEGORY_ID بمعرّف الفئة. على سبيل المثال، bf6505eb-2a0f-47af-a00a-ded40ac72960. افصل بين معرّفات الفئات المتعددة باستخدام فاصلة. احصل على معرّف الفئة باستخدام الأمر list API categories.
  • ‫PUBLISHED_TRUE_OR_FALSE مع true أو false (تلقائي)، حيث يشير true إلى أنّ واجهة برمجة التطبيقات متاحة للجميع. عند نشر التطبيق، يمكنك السماح بالوصول لجميع المستخدمين أو المستخدمين الذين تمت مصادقتهم أو مستخدمين محدّدين.
  • ‫API_PRODUCT باسم منتج واجهة برمجة التطبيقات على سبيل المثال، Hello World 2.

حمولة الاستجابة:

{
  "status": "success",
  "message": "API created",
  "data": {
    "id": 662423,
    "siteId": "my-org-myportal",
    "title": "My Test Catalog 4",
    "description": "",
    "published": false,
    "visibility": false,
    "apiId": "uxb9wjua",
    "apiProductName": "uXB9wJUa",
    "edgeAPIProductName": "uXB9wJUa",
    "specId": null,
    "specContent": null,
    "specTitle": null,
    "snapshotExists": false,
    "snapshotModified": null,
    "modified": 1729635493000,
    "anonAllowed": false,
    "imageUrl": null,
    "snapshotState": null,
    "requireCallbackUrl": false,
    "categoryIds": [],
    "specFormat": null,
    "specModified": null,
    "snapshotOutdated": null,
    "snapshotSourceMissing": false,
    "graphqlSchema": null,
    "graphqlEndpointUrl": null,
    "graphqlSchemaDisplayName": null,
    "grpcFileName": null,
    "grpcZipContent": null
  },
  "code": null,
  "request_id": "893346193",
  "error_code": null
}

المكان:

  • ‫modified: الوقت الذي تم فيه آخر تعديل على عنصر الكتالوج بالمللي ثانية منذ تاريخ بدء حساب الفترة مثلاً: 1698165480000
  • ‫id: معرّف السلعة في الكتالوج مثلاً: 399668

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

بعد إضافة واجهة برمجة تطبيقات، استخدِم واجهة المستخدم أو طلب بيانات من واجهة برمجة التطبيقات لإجراء التعديلات.

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

يُرجى الرجوع إلى الأقسام اللاحقة للاطّلاع على إعدادات تعديل معيّنة.

واجهة المستخدِم

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

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

curl

بعد إضافة واجهة برمجة تطبيقات، استخدِم طلب update لإجراء تعديلات.

يوضّح لك هذا المثال الخطوات المطلوبة لتغيير حالة واجهة برمجة التطبيقات المنشورة في البوابة من "true" إلى "false". يمكنك تغيير أكثر من إعداد واحد في طلب بيانات واحد من واجهة برمجة التطبيقات إذا لزم الأمر.

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

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN"
    

    غيِّر القيم في السلسلة على الشكل التالي:

    • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
    • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
    • API_DOC مع id الذي تم إنشاؤه للمستند. على سبيل المثال، 399668. استخدِم الأمر list API docs للعثور على هذه القيمة.
    • ACCESS_TOKEN برمز المصادقة المستخدَم للوصول إلى واجهة برمجة تطبيقات Apigee Edge. لمزيد من المعلومات عن المصادقة والرموز المميّزة، يُرجى الاطّلاع على مصادقة الوصول إلى Edge API.

    حمولة الاستجابة:

    {
      "status": "success",
      "message": "apidoc returned",
      "data": {
        "id": 662423,
        "siteId": "my-org-myportal",
        "title": "My Test Catalog 4",
        "description": "",
        "published": false,
        "visibility": false,
        "apiId": "uxb9wjua",
        "apiProductName": "uXB9wJUa",
        "edgeAPIProductName": "uXB9wJUa",
        "specId": null,
        "specContent": null,
        "specTitle": null,
        "snapshotExists": false,
        "snapshotModified": null,
        "modified": 1729635493000,
        "anonAllowed": false,
        "imageUrl": null,
        "snapshotState": null,
        "requireCallbackUrl": false,
        "categoryIds": [],
        "specFormat": null,
        "specModified": null,
        "snapshotOutdated": false,
        "snapshotSourceMissing": false,
        "graphqlSchema": null,
        "graphqlEndpointUrl": null,
        "graphqlSchemaDisplayName": null,
        "grpcFileName": null,
        "grpcZipContent": null
      },
      "code": null,
      "request_id": "601210268",
      "error_code": null
    }
    

  1. يُرجى تضمين القيم القابلة للتغيير التي تريد الاحتفاظ بها في طلب update وتعديل القيم التي تريد تغييرها. في حال حذف سطر، يتم استخدام الإعداد التلقائي. في هذا المثال، غيِّر الإعداد المنشور من false إلى true:

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
        "title": "TITLE",
        "anonAllowed": true,
        "published": true
     }'
    

    غيِّر القيم في السلسلة على الشكل التالي:

    • ‫TITLE مع العنوان المعروض مثلاً: Hello World 2

    حمولة الاستجابة:

    {
      "status": "success",
      "message": "ApiDoc updated",
      "data": {
        "id": 662423,
        "siteId": "my-org-myportal",
        "title": "My Test Catalog 4",
        "description": "",
        "published": true,
        "visibility": true,
        "apiId": "uxb9wjua",
        "apiProductName": "uXB9wJUa",
        "edgeAPIProductName": "uXB9wJUa",
        "specId": null,
        "specContent": null,
        "specTitle": null,
        "snapshotExists": false,
        "snapshotModified": null,
        "modified": 1729989250000,
        "anonAllowed": true,
        "imageUrl": null,
        "snapshotState": null,
        "requireCallbackUrl": false,
        "categoryIds": [],
        "specFormat": null,
        "specModified": null,
        "snapshotOutdated": null,
        "snapshotSourceMissing": false,
        "graphqlSchema": null,
        "graphqlEndpointUrl": null,
        "graphqlSchemaDisplayName": null,
        "grpcFileName": null,
        "grpcZipContent": null
      },
      "code": null,
      "request_id": "738172002",
      "error_code": null
    }
    

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

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

لإدارة نبذة المستند:

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

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

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

استخدِم واجهة المستخدم أو الأمر curl لنشر واجهة برمجة تطبيقات أو إلغاء نشرها على البوابة الإلكترونية.

واجهة المستخدِم

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

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

curl

أدرِج أحد الخيارات التالية في طلب التعديل:

"published": true,    # API is published to your portal
"published": false,   # API is not published in your portal

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

  1. إرجاع القيم الحالية:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN"
  2. استخدِم طلب update لتعديل واجهة برمجة التطبيقات. يُرجى تضمين القيم القابلة للتغيير التي تريد الاحتفاظ بها وتعديل القيم التي تريد تغييرها. إذا حذفت إعدادًا قابلاً للتغيير، يتم استبداله بالقيمة التلقائية.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/  ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
        "title": "TITLE",
        "description": "DESCRIPTION",
        "anonAllowed": ANON_TRUE_OR_FALSE,
        "imageUrl": IMAGE_URL,
        "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
        "categoryIds": [
          "CATEGORY_ID1",
         "CATEGORY_ID2"
        ],
        "published": PUBLISHED_TRUE_OR_FALSE
    }

يمكنك الاطّلاع على إدارة إصدار المستند للحصول على مثال تفصيلي للخطوات والمتغيّرات والحمولة التي تم عرضها.

إدارة مستوى ظهور واجهة برمجة تطبيقات في بوابتك

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

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

استخدِم واجهة المستخدم أو الأمر curl لإدارة مستوى ظهور واجهة برمجة تطبيقات في بوابتك:

واجهة المستخدِم

لإدارة مستوى ظهور واجهة برمجة تطبيقات في بوابتك، اتّبِع الخطوات التالية:

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

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

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

curl

إذا كنت قد سجّلت في الإصدار التجريبي من ميزة إدارة الجمهور، استخدِم واجهة المستخدم لإدارة شرائح الجمهور.

إذا لم تكن مسجّلاً في ميزة إدارة الجمهور، تتم إدارة مستوى العرض باستخدام anonAllowed.

أدرِج أحد الخيارات التالية في طلب update :

  # When not enrolled in the beta release of the audience management feature:

  "anonAllowed": true,      # Anonymous users can see the API
  "anonAllowed": false,     # Only registered users can see the API

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

  1. إرجاع القيم الحالية:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN"
    
  2. استخدِم طلب update لتعديل واجهة برمجة التطبيقات. يجب تضمين القيم القابلة للتغيير التي تريد الاحتفاظ بها وتعديل القيم التي تريد تغييرها. في حال حذف إعداد قابل للتغيير، يتم استخدام القيمة التلقائية.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN" \
         -H "Content-Type: application/json" \
         -d '{
            "title": "TITLE",
            "description": "DESCRIPTION",
            "anonAllowed": ANON_TRUE_OR_FALSE,
            "imageUrl": IMAGE_URL,
            "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
            "categoryIds": [
              "CATEGORY_ID1",
              "CATEGORY_ID2"
            ],
            "published": PUBLISHED_TRUE_OR_FALSE
         }'

يُرجى الاطّلاع على تعديل واجهة برمجة تطبيقات للحصول على مثال تفصيلي للخطوات والمتغيّرات والحمولة المعروضة.

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

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

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

واجهة المستخدِم

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

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

curl

أدرِج أحد الخيارات التالية في طلب update :

  "requireCallbackUrl": true,    # Portal user is required to input a URL
  "requireCallbackUrl": false,   # Portal user is not required to input a URL

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

  1. إرجاع القيم الحالية:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN"
    
  2. استخدِم طلب update لتعديل واجهة برمجة التطبيقات. يجب تضمين القيم القابلة للتغيير التي تريد الاحتفاظ بها وتعديل القيم التي تريد تغييرها. في حال حذف إعداد قابل للتغيير، يتم استخدام القيمة التلقائية.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN" \
         -H "Content-Type: application/json" \
         -d '{
            "title": "TITLE",
            "description": "DESCRIPTION",
            "anonAllowed": ANON_TRUE_OR_FALSE,
            "imageUrl": IMAGE_URL,
            "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
            "categoryIds": [
              "CATEGORY_ID1",
              "CATEGORY_ID2"
            ],
            "published": PUBLISHED_TRUE_OR_FALSE
         }'

يُرجى الاطّلاع على تعديل واجهة برمجة تطبيقات للحصول على مثال تفصيلي للخطوات والمتغيّرات والحمولة المعروضة.

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

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

استخدِم واجهة المستخدم أو الأمر curl لإدارة صورة بطاقة واجهة برمجة التطبيقات:

واجهة المستخدِم

لإدارة صورة بطاقة واجهة برمجة التطبيقات، اتّبِع الخطوات التالية:

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

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

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

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

curl

يُرجى تضمين ما يلي في طلب update :

  # Omit line for no image file

  "imageUrl": "IMAGE_URL"    # URL of the external image or name of the image file

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

  1. إرجاع القيم الحالية:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN"
    
  2. استخدِم طلب update لتعديل واجهة برمجة التطبيقات. يجب تضمين القيم القابلة للتغيير التي تريد الاحتفاظ بها وتعديل القيم التي تريد تغييرها. في حال حذف إعداد قابل للتغيير، يتم استخدام القيمة التلقائية.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN" \
         -H "Content-Type: application/json" \
         -d '{
            "title": "TITLE",
            "description": "DESCRIPTION",
            "anonAllowed": ANON_TRUE_OR_FALSE,
            "imageUrl": IMAGE_URL,
            "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
            "categoryIds": [
              "CATEGORY_ID1",
              "CATEGORY_ID2"
            ],
            "published": PUBLISHED_TRUE_OR_FALSE
         }'

يُرجى الاطّلاع على تعديل واجهة برمجة تطبيقات للحصول على مثال تفصيلي للخطوات والمتغيّرات والحمولة المعروضة.

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

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

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

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

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

واجهة المستخدِم

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

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

curl

يُرجى تضمين ما يلي في طلب update :

  # Omit line for no categories

  "categoryIds": [
      "CATEGORY_ID1",      # A category ID number
      "CATEGORY_ID2"       # A category ID number
    ],

استخدِم الأمر list categories للحصول على أرقام تعريف الفئات.

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

  1. إرجاع القيم الحالية:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN"
    
  2. استخدِم طلب update لتعديل واجهة برمجة التطبيقات. يجب تضمين القيم القابلة للتغيير التي تريد الاحتفاظ بها وتعديل القيم التي تريد تغييرها. في حال حذف إعداد قابل للتغيير، يتم استخدام القيمة التلقائية.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN" \
         -H "Content-Type: application/json" \
         -d '{
            "title": "TITLE",
            "description": "DESCRIPTION",
            "anonAllowed": ANON_TRUE_OR_FALSE,
            "imageUrl": IMAGE_URL,
            "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
            "categoryIds": [
              "CATEGORY_ID1",
              "CATEGORY_ID2"
            ],
            "published": PUBLISHED_TRUE_OR_FALSE
         }'

يُرجى الاطّلاع على تعديل واجهة برمجة تطبيقات للحصول على مثال تفصيلي للخطوات والمتغيّرات والحمولة المعروضة.

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

استخدِم واجهة المستخدم أو الأمر curl لتعديل العنوان والوصف المعروضَين:

واجهة المستخدِم

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

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

curl

يُرجى تضمين ما يلي في طلب update :

  "title": "TITLE",    # Display title
  "description": "DESCRIPTION",  # Display description

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

  1. إرجاع القيم الحالية:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN"
    
  2. استخدِم طلب update لتعديل واجهة برمجة التطبيقات. يجب تضمين القيم القابلة للتغيير التي تريد الاحتفاظ بها وتعديل القيم التي تريد تغييرها. في حال حذف إعداد قابل للتغيير، يتم استخدام القيمة التلقائية.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
         -H "Authorization: Bearer ACCESS_TOKEN" \
         -H "Content-Type: application/json" \
         -d '{
            "title": "TITLE",
            "description": "DESCRIPTION",
            "anonAllowed": ANON_TRUE_OR_FALSE,
            "imageUrl": IMAGE_URL,
            "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
            "categoryIds": [
              "CATEGORY_ID1",
              "CATEGORY_ID2"
            ],
            "published": PUBLISHED_TRUE_OR_FALSE
         }'

يُرجى الاطّلاع على تعديل واجهة برمجة تطبيقات للحصول على مثال تفصيلي للخطوات والمتغيّرات والحمولة المعروضة.

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

استخدِم واجهة المستخدم أو الأمر curl لإزالة واجهة برمجة تطبيقات من بوابتك:

واجهة المستخدِم

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

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

curl

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

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN"

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • API_DOC مع id الذي تم إنشاؤه للمستند. على سبيل المثال، 399668. استخدِم الأمر list API docs للعثور على هذه القيمة.
  • ACCESS_TOKEN برمز المصادقة المستخدَم للوصول إلى واجهة برمجة تطبيقات Apigee Edge. لمزيد من المعلومات عن المصادقة والرموز المميّزة، يُرجى الاطّلاع على مصادقة الوصول إلى Edge API.

حمولة الاستجابة:

{
  "status": "success",
  "message": "Apidoc deleted",
  "data": {
  },
  "code": null,
  "request_id": "1790036484",
  "error_code": null
}

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

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

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

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

واجهة المستخدِم

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

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

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

curl

لتعديل محتوى مستندات OpenAPI أو GraphQL:

OpenAPI

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"oasDocumentation": {
           "spec":{ "displayName":"DISPLAY_NAME",
                    "contents":"CONTENTS"}
            }
        }'

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • API_DOC مع id الذي تم إنشاؤه للمستند. على سبيل المثال، 399668. استخدِم الأمر list API docs للعثور على هذه القيمة.
  • ‫DISPLAY_NAME مع الاسم المعروض لمستندات واجهة برمجة التطبيقات على سبيل المثال، Hello World 2.
  • ‫CONTENTS مع سلسلة المحتوى المشفّرة بترميز base64 لمستندات واجهة برمجة التطبيقات تحتوي معظم بيئات التطوير على أداة تحويل base64، أو تتوفّر العديد من أدوات التحويل على الإنترنت.

حمولة الاستجابة:

{
 "status":"success",
 "message":"Api documentation updated",
 "requestId":"645138278"
 "data": {
   "oasDocumentation": {
     "spec": {
        "displayName": "Hello World 2"
      },
     "Format": "YAML"
   }
 }
}

GraphQL

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"graphqlDocumentation": {
         "schema":{"displayName":"DISPLAY_NAME",
         "contents":"CONTENTS"},
         "endpointUri": "ENDPOINT_URI"
          }
      }'

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • API_DOC مع id الذي تم إنشاؤه للمستند. على سبيل المثال، 399668. استخدِم الأمر list API docs للعثور على هذه القيمة.
  • ‫DISPLAY_NAME مع الاسم المعروض لمستندات واجهة برمجة التطبيقات على سبيل المثال، Hello World 2.
  • ENDPOINT_URI باسم نطاق معرّف الموارد المنتظم (URI) لنقطة النهاية. على سبيل المثال: https://demo.google.com/graphql.
  • ‫CONTENTS مع سلسلة المحتوى المشفّرة بترميز base64 لمستندات واجهة برمجة التطبيقات تحتوي معظم بيئات التطوير على أداة تحويل base64، أو تتوفّر العديد من أدوات التحويل على الإنترنت.

حمولة الاستجابة:

{
"status": "success",
"message": "ApiDocDocumentation updated",
"data": {
  "oasDocumentation": null,
  "graphqlDocumentation": {
    "schema": {
      "displayName": "schema.docs.graphql",
      "contents": ""
    },
    "endpointUri": "https://demo.google.com/graphql"
  }
},
"code": null,
"request_id": "640336173",
"error_code": null
}

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

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

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

واجهة المستخدِم

curl

لتنزيل مستندات واجهة برمجة التطبيقات باستخدام get documentation:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN"

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • API_DOC مع id الذي تم إنشاؤه للمستند. على سبيل المثال، 399668. استخدِم الأمر list API docs للعثور على هذه القيمة.

    حمولة الاستجابة:

{
  "status": "success",
  "message": "ApiDocDocumentation returned",
  "data": {
    "oasDocumentation": {
      "spec": {
        "displayName": "mock",
        "contents": "b3BlbmFwaTogMy4wLjAKaW5mbzoKICBkZXNjcmlw ..."
      },
      "format": "YAML"
    },
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "269996898",
  "error_code": null
}

المكان:

‫contents: السلسلة المشفّرة بترميز base64 لمحتوى مستندات واجهة برمجة التطبيقات

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

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

واجهة المستخدِم

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

curl

لمحو المحتوى الحالي، استخدِم update API:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{}'

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • API_DOC مع id الذي تم إنشاؤه للمستند. على سبيل المثال، 399668. استخدِم الأمر list API docs للعثور على هذه القيمة.

حمولة الاستجابة:

{
  "status": "success",
  "message": "ApiDocDocumentation updated",
  "data": {
    "oasDocumentation": null,
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "304329676",
  "error_code": null
}

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

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

عرض الفئات

استخدِم واجهة المستخدم أو الأمر curl لعرض واجهات برمجة التطبيقات في البوابة.

واجهة المستخدِم

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

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

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

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

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

علامة التبويب &quot;الفئات&quot; التي تعرض اسم الفئة وأسماء واجهات برمجة التطبيقات المخصّصة وإجمالي عددها

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

curl

لإدراج الفئات:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN"

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • ACCESS_TOKEN برمز المصادقة المستخدَم للوصول إلى واجهة برمجة تطبيقات Apigee Edge. لمزيد من المعلومات عن المصادقة والرموز المميّزة، يُرجى الاطّلاع على مصادقة الوصول إلى Edge API.

حمولة الاستجابة:

{
  "status": "success",
  "message": "all ApiCategory items returned",
  "data": [
    {
      "id": "e0518597-ece2-4d7d-ba7c-d1793df0f8db",
      "siteId": "my-org-myportal",
      "name": "My Category"
    },
    {
      "id": "61c1014c-89c9-40e6-be3c-69cca3505620",
      "siteId": "my-org-myportal",
      "name": "test2"
    }
  ],
  "code": null,
  "request_id": "1263510680",
  "error_code": null
}

المكان:

  • ‫id: معرّف عنصر الفئة على سبيل المثال: 61c1014c-89c9-40e6-be3c-69cca3505620.

إضافة فئة

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

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

استخدِم واجهة المستخدم أو الأمر curl لإضافة فئة:

واجهة المستخدِم

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

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

curl

لإضافة فئة:

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • ACCESS_TOKEN برمز المصادقة المستخدَم للوصول إلى واجهة برمجة تطبيقات Apigee Edge. لمزيد من المعلومات عن المصادقة والرموز المميّزة، يُرجى الاطّلاع على مصادقة الوصول إلى Edge API.
  • CATEGORY_NAME باسم الفئة. على سبيل المثال: demo-backend.

حمولة الاستجابة:

{
  "status": "success",
  "message": "API category created",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend"
  },
  "code": null,
  "request_id": "363146927",
  "error_code": null
}

تعديل فئة

استخدِم واجهة المستخدم أو الأمر curl لتعديل فئة:

واجهة المستخدِم

لتعديل فئة:

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

curl

لتعديل فئة:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID"  \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • ‫CATEGORY_ID بمعرّف الفئة. على سبيل المثال، bf6505eb-2a0f-47af-a00a-ded40ac72960. افصل بين معرّفات الفئات المتعددة باستخدام فاصلة. احصل على معرّف الفئة باستخدام الأمر list API categories.
  • ACCESS_TOKEN برمز المصادقة المستخدَم للوصول إلى واجهة برمجة تطبيقات Apigee Edge. لمزيد من المعلومات عن المصادقة والرموز المميّزة، يُرجى الاطّلاع على مصادقة الوصول إلى Edge API.
  • CATEGORY_NAME باسم الفئة. على سبيل المثال: demo-backend.

حمولة الاستجابة:

{
  "status": "success",
  "message": "ApiCategory updated",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend-test"
  },
  "code": null,
  "request_id": "1976875617",
  "error_code": null
}

حذف فئة

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

استخدِم واجهة المستخدم أو الأمر curl لحذف فئة:

واجهة المستخدِم

لحذف فئة:

  1. انتقِل إلى صفحة "الفئات".
  2. ضع المؤشر فوق الفئة التي تريد تعديلها لعرض قائمة الإجراءات.
  3. انقر على حذف.
  4. انقر على حذف للتأكيد.

curl

لحذف فئة:

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json"

غيِّر القيم في السلسلة على الشكل التالي:

  • ‫ORG_NAME باسم المؤسسة مثلاً: my-org
  • ‫SITE_ID باسم البوابة، بالتنسيق ORG_NAME-PORTAL_NAME، حيث يمثّل ORG_NAME اسم المؤسسة ويمثّل PORTAL_NAME اسم البوابة بعد تحويله إلى أحرف صغيرة وإزالة المسافات والشرطات. على سبيل المثال: my-org-myportal.
  • ‫CATEGORY_ID بمعرّف الفئة. على سبيل المثال: bf6505eb-2a0f-47af-a00a-ded40ac72960. يمكنك الحصول على معرّف الفئة باستخدام الأمر list API categories.
  • ACCESS_TOKEN برمز المصادقة المستخدَم للوصول إلى واجهة برمجة تطبيقات Apigee Edge. لمزيد من المعلومات عن المصادقة والرموز المميّزة، يُرجى الاطّلاع على مصادقة الوصول إلى Edge API.

حمولة الاستجابة:

{
  "status": "success",
  "message": "ApiCategory deleted",
  "data": {
  },
  "code": null,
  "request_id": "2032819627",
  "error_code": null
}

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

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

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

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

خطأ: يحتوي عنوان "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>، كما هو موضّح في المقتطف أدناه. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة خطأ CORS : يحتوي العنوان على قيم متعددة '*, *'، ولكن يُسمح بقيمة واحدة فقط.

<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.