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

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

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

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

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

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

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

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.

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

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

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

3. انقر على + إضافة.

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

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

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

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

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

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

يوضّح لك هذا المثال الخطوات المطلوبة لتغيير حالة النشر لواجهة برمجة التطبيقات في البوابة من 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. أدرِج القيم القابلة للتغيير التي تريد الاحتفاظ بها في طلب التعديل، وعدِّل القيم التي تريد تغييرها. في حال حذف سطر، سيتم استخدام الإعداد التلقائي. في هذا المثال، غيِّر الإعداد المنشور من 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
   }
   

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

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

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. استخدِم طلب التعديل لتعديل واجهة برمجة التطبيقات. أدرِج القيم القابلة للتغيير التي تريد الاحتفاظ بها وعدِّل القيم التي تريد تغييرها. إذا حذفت إعدادًا قابلاً للتعديل، سيتم استبداله بالقيمة التلقائية.

   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
   }

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

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

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

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 لرد الاتصال الخاص بواجهة برمجة تطبيقات، اتّبِع الخطوات التالية:

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
        }'

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

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

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

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
        }'

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

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

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

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
        }'

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

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

لتعديل عنوان العرض والوصف، اتّبِع الخطوات التالية:

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
        }'

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

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

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

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. انقر على edit تعديل.
6. نفِّذ إحدى المهام التالية:
   • لإعادة تحميل لقطة لمستند OpenAPI قديم، انقر على إعادة تحميل اللقطة.
   • لتغيير المستند المستخدَم لإنشاء مستندات واجهة برمجة التطبيقات، انقر على اختيار مستند ضمن "مستندات واجهة برمجة التطبيقات" واختَر المستند الجديد.
7. في لوحة مستندات واجهة برمجة التطبيقات، اختَر أحد الخيارات التالية:
   • مستند OpenAPI
   • مخطط GraphQL
8. انقر على اختيار مستند واختَر أحدث نسخة من المستند.
9. بالنسبة إلى GraphQL، حدِّد عنوان URL لنقطة النهاية.
10. انقر على حفظ.

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

curl

لتعديل محتوى مستندات OpenAPI أو 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 '{"oasDocumentation": {
           "spec":{ "displayName":"DISPLAY_NAME",
                    "contents":"CONTENTS"}
            }
        }'

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

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"
          }
      }'

{
"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. انقر على edit تعديل.
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
}

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

للاطّلاع على صفحة "الفئات"، اتّبِع الخطوات التالية:

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

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

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

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

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

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

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.

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

لإضافة فئة يدويًا، اتّبِع الخطوات التالية:

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
}

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

لتعديل فئة، اتّبِع الخطوات التالية:

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
}

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

لحذف فئة، اتّبِع الخطوات التالية:

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
}