API های خود را منتشر کنید

UI

برای مشاهده کاتالوگ API:

1. Publish > Portals را انتخاب کنید و پورتال خود را انتخاب کنید.
2. روی کاتالوگ API در صفحه اصلی پورتال کلیک کنید. همچنین، می‌توانید کاتالوگ API را در منوی کشویی پورتال در نوار پیمایش بالا انتخاب کنید.

برگه APIs در کاتالوگ API لیستی از APIهایی را که به پورتال شما اضافه شده اند نشان می دهد.

همانطور که در شکل قبل مشخص شد، تب APIs به شما اجازه می دهد:

• جزئیات API های موجود در پورتال خود را مشاهده کنید
• یک API به پورتال خود اضافه کنید
• با انجام یک یا چند کار زیر یک API را در پورتال خود ویرایش کنید:
  • برای به روز رسانی اسناد مرجع API ، عکس فوری یک سند مرتبط با یک محصول API را مدیریت کنید
  • یک API را در پورتال خود منتشر یا لغو انتشار کنید
  • قابلیت مشاهده یک API را در پورتال خود مدیریت کنید :
  • URL بازگشت به تماس را برای یک API مدیریت کنید
  • تصویر را برای یک کارت API مدیریت کنید
  • یک API را با استفاده از دسته‌ها برچسب‌گذاری کنید
  • عنوان و توضیحات API را ویرایش کنید
• یک API را از پورتال خود حذف کنید
• دسته های مورد استفاده برای کشف API های مرتبط را مدیریت کنید
• به سرعت مشخصاتی را که قدیمی هستند یا از فروشگاه مشخصات حذف شده اند شناسایی کنید
• به سرعت APIهای یتیمی را شناسایی کنید که محصول API مرتبط آنها از Apigee Edge حذف شده است، و محصول API را دوباره ایجاد کنید یا API را از پورتال خود حذف کنید.

حلقه کردن

برای فهرست کردن API ها :

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 API. برای اطلاعات بیشتر در مورد احراز هویت و نشانه‌ها، به تأیید اعتبار دسترسی به 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 .

UI

برای افزودن یک API به پورتال خود:

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.

3. روی + افزودن کلیک کنید.

   افزودن یک محصول API به کاتالوگ نمایش داده می شود.

4. محصول API را که می خواهید به پورتال خود اضافه کنید انتخاب کنید.

5. روی Next کلیک کنید. صفحه جزئیات API نمایش داده می شود.

6. محتوای اسناد مرجع API و قابلیت مشاهده آن در پورتال را پیکربندی کنید:

   میدان	توضیحات
   منتشر شد	برای انتشار API در پورتال خود، Published را انتخاب کنید. اگر برای انتشار API آماده نیستید، کادر را پاک کنید. می‌توانید بعداً تنظیم را تغییر دهید، همانطور که در Publish توضیح داده شد یا یک API را در پورتال خود لغو انتشار کنید .
   نمایش عنوان	عنوان API خود را که در کاتالوگ نمایش داده می شود به روز کنید. به طور پیش فرض از نام محصول API استفاده می شود. می‌توانید بعداً عنوان نمایش را تغییر دهید، همانطور که در ویرایش عنوان نمایش و توضیحات توضیح داده شده است.
   توضیحات نمایش	توضیحات API خود را که در کاتالوگ نمایش داده می شود به روز کنید. به طور پیش فرض، از توضیحات محصول API استفاده می شود. می‌توانید بعداً شرح نمایش را تغییر دهید، همانطور که در ویرایش عنوان نمایش و توضیحات توضیح داده شده است.
   از توسعه دهندگان بخواهید که URL بازگشت به تماس را مشخص کنند	اگر می‌خواهید از برنامه‌نویسان برنامه بخواهید که URL بازگشت به تماس را مشخص کنند، آن را فعال کنید. همانطور که در مدیریت URL پاسخ به تماس برای یک API توضیح داده شده است، می‌توانید نشانی وب پاسخ به تماس را بعداً اضافه یا به‌روزرسانی کنید.
   اسناد API	برای استفاده از یک سند OpenAPI: سند OpenAPI را انتخاب کنید. روی انتخاب سند کلیک کنید. یکی از مراحل زیر را انجام دهید: روی تب My Specs کلیک کنید و یک مشخصات را از فروشگاه مشخصات انتخاب کنید. روی تب آپلود فایل کلیک کنید و یک فایل را آپلود کنید. روی زبانه Import from a URL کلیک کنید و مشخصات را از URL وارد کنید. روی انتخاب کلیک کنید. برای استفاده از طرحواره GraphQL: GraphQL Schema را انتخاب کنید. روی انتخاب سند کلیک کنید. به طرحواره GraphQL بروید و آن را انتخاب کنید. روی انتخاب کلیک کنید. همچنین، می‌توانید بدون سند را انتخاب کنید و بعد از اضافه شدن API یکی را اضافه کنید، همانطور که در مدیریت عکس فوری سند توضیح داده شده است.
   قابلیت مشاهده API	اگر در نسخه بتا ویژگی مدیریت مخاطب ثبت نام نکرده اید، یکی از گزینه های زیر را انتخاب کنید: کاربران ناشناس به همه کاربران اجازه می دهند API را مشاهده کنند. کاربران ثبت نام شده اجازه می دهند فقط کاربران ثبت نام شده بتوانند API را مشاهده کنند. اگر در نسخه بتا ویژگی مدیریت مخاطب ثبت نام کرده اید، یکی از گزینه های زیر را انتخاب کنید: عمومی (قابل مشاهده برای همه) تا به همه کاربران اجازه مشاهده API را بدهد. کاربران احراز هویت شده برای اینکه فقط کاربران ثبت نام شده بتوانند API را مشاهده کنند. مخاطبان انتخاب شده برای انتخاب مخاطبان خاصی که می خواهید قادر به مشاهده API باشند. می‌توانید بعداً نمایان بودن مخاطب را مدیریت کنید، همانطور که در مدیریت نمایان بودن یک API در پورتال خود توضیح داده شده است.
   نمایش تصویر	برای نمایش تصویر روی کارت API در صفحه APIها، روی انتخاب تصویر کلیک کنید. در گفتگوی انتخاب تصویر ، یک تصویر موجود را انتخاب کنید، یک تصویر جدید آپلود کنید یا نشانی اینترنتی یک تصویر خارجی را ارائه دهید و روی انتخاب کلیک کنید. تصویر کوچک API را پیش‌نمایش کنید و روی Select کلیک کنید. می‌توانید بعداً یک تصویر اضافه کنید، همانطور که در مدیریت تصویر برای کارت API توضیح داده شده است. هنگام تعیین یک تصویر با URL خارجی، تصویر در دارایی های شما آپلود نمی شود. علاوه بر این، بارگیری تصویر در پورتال یکپارچه منوط به در دسترس بودن آن خواهد بود که ممکن است توسط سیاست های امنیتی محتوا مسدود یا محدود شود.
   دسته بندی ها	دسته‌هایی را اضافه کنید که API به آنها برچسب‌گذاری می‌شود تا توسعه‌دهندگان برنامه بتوانند APIهای مرتبط را در صفحه APIها کشف کنند. برای شناسایی یک دسته: یک دسته را از لیست کشویی انتخاب کنید. یک دسته جدید را با تایپ کردن نام آن و فشار دادن Enter اضافه کنید. دسته جدید به صفحه دسته‌ها اضافه می‌شود و هنگام افزودن یا ویرایش سایر APIها در دسترس قرار می‌گیرد.

7. روی ذخیره کلیک کنید.

حلقه کردن

برای افزودن یک API به پورتال خود:

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 API. برای اطلاعات بیشتر در مورد احراز هویت و نشانه‌ها، به تأیید اعتبار دسترسی به Edge API مراجعه کنید.
• TITLE با عنوان نمایش. به عنوان مثال، Hello World 2 .
• DESCRIPTION با توضیحات نمایشگر. به عنوان مثال، Simple hello world example .
• ANON_TRUE_OR_FALSE با true یا false (پیش‌فرض)، که در آن true به این معنی است که این API قابل مشاهده عمومی است و می‌توان آن را به‌صورت ناشناس مشاهده کرد. در غیر این صورت، فقط کاربران ثبت نام شده می توانند آن را مشاهده کنند.
• 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 categorys دریافت کنید.
• PUBLISHED_TRUE_OR_FALSE با true یا false (پیش‌فرض)، جایی که true نشان می‌دهد که API برای عموم در دسترس است. هنگامی که منتشر می شود، می توانید به همه کاربران، کاربران احراز هویت شده یا کاربران خاص اجازه دسترسی دهید .
• API_PRODUCT با نام محصول API. به عنوان مثال، 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 .

UI

برای ویرایش یک API:

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
4. کلیک کنید ویرایش کنید .
5. در زیر جزئیات API ، هر گونه تغییری را انجام دهید. توضیحات گزینه‌ها را در افزودن یک API ببینید.
6. روی ذخیره کلیک کنید.

حلقه کردن

هنگامی که یک API اضافه کردید، از تماس به روز رسانی برای انجام ویرایش استفاده کنید.

این مثال شما را از طریق مراحل مورد نیاز برای تغییر وضعیت منتشر شده API در پورتال خود از true به false راهنمایی می کند. در صورت لزوم می توانید بیش از یک تنظیم را در یک تماس API تغییر دهید.

1. به منظور تعیین مکان id تولید شده که به طور منحصر به فرد هر API را شناسایی می کند، فهرستی از APIهای موجود در پورتال خود را همانطور که در Explore APIs توضیح داده شده است دریافت کنید.

2. مقادیر فعلی را برای یک API خاص برگردانید :

   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 API. برای اطلاعات بیشتر در مورد احراز هویت و نشانه‌ها، به تأیید اعتبار دسترسی به 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
   }
   

UI

برای انتشار یا لغو انتشار یک API در پورتال خود:

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
4. کلیک کنید ویرایش کنید .
5. در زیر جزئیات API ، Published (در فهرست فهرست شده) را انتخاب یا پاک کنید تا API را به ترتیب در پورتال خود منتشر یا لغو کنید.
6. روی ذخیره کلیک کنید.

حلقه کردن

یکی از موارد زیر را در تماس به‌روزرسانی قرار دهید:

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

برای ویرایش API:

1. مقادیر فعلی را برگردانید :

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

2. از تماس به روز رسانی برای ویرایش API استفاده کنید. مقادیر قابل تغییری را که می‌خواهید حفظ کنید، اضافه کنید و مقادیری را که می‌خواهید تغییر دهید، تغییر دهید. اگر یک تنظیم قابل تغییر را حذف کنید، با مقدار پیش فرض بازنویسی می شود.

   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
   }

برای مثالی دقیق از مراحل، متغیرها و بار بازگشتی به مدیریت نسخه سند مراجعه کنید.

UI

برای مدیریت نمایان بودن یک API در پورتال خود:

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
4. کلیک کنید ویرایش کنید .

5. تنظیم دید را انتخاب کنید. اگر در نسخه بتا ویژگی مخاطبان ثبت نام کرده اید، یکی از گزینه های زیر را انتخاب کنید:

   • عمومی (قابل مشاهده برای همه) تا به همه کاربران اجازه مشاهده صفحه را بدهد.
   • کاربران احراز هویت شده تا فقط کاربران ثبت نام شده بتوانند صفحه را مشاهده کنند.
   • مخاطبان انتخاب شده برای انتخاب مخاطبان خاصی که می خواهید بتوانید صفحه را مشاهده کنید. به مدیریت مخاطبان پورتال خود مراجعه کنید.
   در غیر این صورت یکی از گزینه های زیر را انتخاب کنید:
   • کاربران ناشناس به همه کاربران اجازه مشاهده صفحه را می دهند.
   • کاربران ثبت نام شده اجازه می دهند فقط کاربران ثبت نام شده بتوانند صفحه را مشاهده کنند.

6. روی ارسال کلیک کنید.

حلقه کردن

اگر در نسخه بتا ویژگی مدیریت مخاطب ثبت نام کرده اید، از رابط کاربری برای مدیریت مخاطبان استفاده کنید.

اگر در ویژگی مدیریت مخاطب ثبت نام نکرده‌اید، قابلیت مشاهده با استفاده از 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

برای ویرایش 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. از تماس به روز رسانی برای ویرایش API استفاده کنید. مقادیر قابل تغییری را که می‌خواهید حفظ کنید، اضافه کنید و مقادیری را که می‌خواهید تغییر دهید، تغییر دهید. اگر یک تنظیم قابل تغییر را حذف کنید، از مقدار پیش فرض استفاده می شود.

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

برای مثالی دقیق از مراحل، متغیرها و بار بازگشتی به ویرایش یک API مراجعه کنید.

UI

برای مدیریت URL برگشت به تماس برای یک API:

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
4. کلیک کنید ویرایش کنید .
5. در زیر جزئیات API ، کادر بررسی Require developers to specify a URL backback box را انتخاب یا پاک کنید.
6. روی ذخیره کلیک کنید.

حلقه کردن

یکی از موارد زیر را در تماس update قرار دهید:

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

برای ویرایش 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. از تماس به روز رسانی برای ویرایش API استفاده کنید. مقادیر قابل تغییری را که می‌خواهید حفظ کنید، اضافه کنید و مقادیری را که می‌خواهید تغییر دهید، تغییر دهید. اگر یک تنظیم قابل تغییر را حذف کنید، از مقدار پیش فرض استفاده می شود.

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

برای مثالی دقیق از مراحل، متغیرها و بار بازگشتی به ویرایش یک API مراجعه کنید.

UI

برای مدیریت تصویر برای یک کارت API:

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
4. کلیک کنید ویرایش کنید .

5. در زیر جزئیات API :

   • برای مشخص کردن یا آپلود تصویر در صورت انتخاب هیچ تصویری، روی Select image کلیک کنید.
   • روی تغییر تصویر کلیک کنید تا تصویر دیگری را مشخص یا آپلود کنید.
   • برای حذف روی x در تصویر کلیک کنید.

   هنگام مشخص کردن یک تصویر، یا یک تصویر با یک URL خارجی که برای آیتم کاتالوگ استفاده می شود، یا یک مسیر برای فایل های تصویری ذخیره شده در پورتال ، به عنوان مثال، /files/book-tree.jpg را مشخص کنید. هنگام تعیین URL یک تصویر خارجی، تصویر در دارایی های شما آپلود نمی شود. علاوه بر این، بارگیری تصویر در پورتال یکپارچه منوط به در دسترس بودن آن خواهد بود که ممکن است توسط سیاست های امنیتی محتوا مسدود یا محدود شود.

6. روی ذخیره کلیک کنید.

حلقه کردن

موارد زیر را در تماس update قرار دهید:

  # Omit line for no image file

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

برای ویرایش 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. از تماس به روز رسانی برای ویرایش API استفاده کنید. مقادیر قابل تغییری را که می‌خواهید حفظ کنید، اضافه کنید و مقادیری را که می‌خواهید تغییر دهید، تغییر دهید. اگر یک تنظیم قابل تغییر را حذف کنید، از مقدار پیش فرض استفاده می شود.

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

برای مثالی دقیق از مراحل، متغیرها و بار بازگشتی به ویرایش یک API مراجعه کنید.

UI

برای برچسب گذاری یک API به دسته ها هنگام ویرایش API:

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
4. کلیک کنید ویرایش کنید .
5. در قسمت Categories کلیک کنید و یکی از مراحل زیر را انجام دهید:
   • یک دسته را از لیست کشویی انتخاب کنید.
   • یک دسته جدید را با تایپ کردن نام آن و فشار دادن Enter اضافه کنید. دسته جدید به صفحه دسته‌ها اضافه می‌شود و هنگام افزودن یا ویرایش سایر APIها در دسترس قرار می‌گیرد.
6. برای برچسب گذاری API در دسته های بیشتر، تکرار کنید.
7. روی ذخیره کلیک کنید.

حلقه کردن

موارد زیر را در تماس update قرار دهید:

  # Omit line for no categories

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

برای بدست آوردن شماره شناسه دسته از دستور list categories استفاده کنید.

برای ویرایش 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. از تماس به روز رسانی برای ویرایش API استفاده کنید. مقادیر قابل تغییری را که می‌خواهید حفظ کنید، اضافه کنید و مقادیری را که می‌خواهید تغییر دهید، تغییر دهید. اگر یک تنظیم قابل تغییر را حذف کنید، از مقدار پیش فرض استفاده می شود.

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

برای مثالی دقیق از مراحل، متغیرها و بار بازگشتی به ویرایش API مراجعه کنید.

UI

برای ویرایش عنوان نمایش و توضیحات:

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
4. کلیک کنید ویرایش کنید .
5. فیلدهای عنوان نمایش و توضیحات نمایش را در صورت لزوم ویرایش کنید.
6. روی ذخیره کلیک کنید.

حلقه کردن

موارد زیر را در تماس update قرار دهید:

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

برای ویرایش 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. از تماس به روز رسانی برای ویرایش API استفاده کنید. مقادیر قابل تغییری را که می‌خواهید حفظ کنید، اضافه کنید و مقادیری را که می‌خواهید تغییر دهید، تغییر دهید. اگر یک تنظیم قابل تغییر را حذف کنید، از مقدار پیش فرض استفاده می شود.

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

برای مثالی دقیق از مراحل، متغیرها و بار بازگشتی به ویرایش یک API مراجعه کنید.

UI

برای حذف یک API از پورتال خود:

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اند، APIها را انتخاب کنید.
3. مکان نما خود را روی API در لیست قرار دهید تا منوی اقدامات نمایش داده شود.
4. کلیک کنید حذف کنید .

حلقه کردن

برای حذف یک API از پورتال خود :

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 API. برای اطلاعات بیشتر در مورد احراز هویت و نشانه‌ها، به تأیید اعتبار دسترسی به Edge API مراجعه کنید.

بار پاسخگویی:

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

UI

1. به کاتالوگ API دسترسی داشته باشید .
2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
4. وضعیت عکس فوری را بررسی کنید. اگر قدیمی باشد، پیام زیر نمایش داده می شود:
5. روی edit ویرایش کلیک کنید.
6. یکی از کارهای زیر را انجام دهید:
   • برای بازخوانی یک عکس فوری از یک سند OpenAPI که قدیمی است، روی Refresh Snapshot کلیک کنید.
   • برای تغییر سندی که برای تولید اسناد API استفاده می‌شود، در زیر API documentation، روی Select Document کلیک کنید و سند جدید را انتخاب کنید.
7. در پانل اسناد API ، یکی از موارد زیر را انتخاب کنید:
   • سند OpenAPI
   • طرحواره GraphQL
8. روی Select Document کلیک کنید و آخرین نسخه سند را انتخاب کنید.
9. برای GraphQL، URL Endpoint را مشخص کنید.
10. روی ذخیره کلیک کنید.

مستندات مرجع API از سند ارائه شده و به صفحه مرجع API اضافه می شود. وضعیت عکس فوری به فعلی به روز می شود:

حلقه کردن

برای به‌روزرسانی محتوای اسناد 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
}

UI

حلقه کردن

برای بارگیری مستندات API با استفاده از مستندات دریافت :

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 . برای یافتن این مقدار از دستور لیست 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 از مطالب اسناد API.

UI

1. به کاتالوگ API دسترسی پیدا کنید .
2. اگر قبلاً انتخاب نشده است ، روی برگه APIS کلیک کنید.
3. در ردیف API که می خواهید ویرایش کنید کلیک کنید.
4. روی edit ویرایش کلیک کنید.
5. در صفحه مستندات API ، بدون اسناد انتخاب کنید.
6. روی ذخیره کلیک کنید.

حلقه کردن

برای پاک کردن محتوای موجود از API Update استفاده کنید:

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 . برای یافتن این مقدار از دستور لیست API Docs استفاده کنید.

پاسخ بار پاسخ:

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

UI

برای مشاهده صفحه دسته بندی ها:

1. Publish> Portals را انتخاب کنید و پورتال خود را انتخاب کنید.
2. روی کاتالوگ API در صفحه اصلی پورتال کلیک کنید.

   از طرف دیگر ، می توانید کاتالوگ API را در منوی کشویی پورتال در نوار ناوبری بالا انتخاب کنید.

3. روی تب دسته ها کلیک کنید.

برگه دسته بندی ها در کاتالوگ API لیست دسته هایی را که برای پورتال شما تعریف شده است نشان می دهد.

همانطور که در شکل قبلی برجسته شد ، صفحه APIS شما را قادر می سازد:

• دسته ها و API هایی را که برچسب گذاری شده اند مشاهده کنید
• یک دسته اضافه کنید
• یک دسته را ویرایش کنید
• حذف یک دسته
• مدیریت API های منتشر شده در پورتال خود را. به کاوش در کاتالوگ API مراجعه کنید

حلقه کردن

برای لیست دسته بندی ها :

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 با نشانه تأیید اعتبار مورد استفاده برای دسترسی به API Apigee Edge. برای کسب اطلاعات بیشتر در مورد تأیید اعتبار و نشانه ها ، به Authenticate Access به 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 .

UI

برای اضافه کردن دستی یک دسته:

1. به صفحه دسته ها دسترسی پیدا کنید .
2. روی + افزودن کلیک کنید.
3. نام دسته جدید خود را وارد کنید.
4. به صورت اختیاری ، یک یا چند API را انتخاب کنید تا به دسته بندی برچسب بزنید.
5. روی ایجاد کلیک کنید.

حلقه کردن

برای افزودن یک دسته :

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 با نشانه تأیید اعتبار مورد استفاده برای دسترسی به API Apigee Edge. برای کسب اطلاعات بیشتر در مورد تأیید اعتبار و نشانه ها ، به Authenticate Access به 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
}

UI

برای ویرایش یک دسته:

1. به صفحه دسته ها دسترسی پیدا کنید .
2. کلیک کنید ویرایش کنید .
3. نام گروه را ویرایش کنید.
4. برچسب های API را اضافه یا حذف کنید.
5. روی ذخیره کلیک کنید.

حلقه کردن

برای ویرایش یک دسته :

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 . شناسه های چند طبقه را با کاما جدا کنید. شناسه دسته را با دستور لیست API دسته بندی دریافت کنید.
• ACCESS_TOKEN با نشانه تأیید اعتبار مورد استفاده برای دسترسی به API Apigee Edge. برای کسب اطلاعات بیشتر در مورد تأیید اعتبار و نشانه ها ، به Authenticate Access به 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
}

UI

برای حذف یک دسته:

1. به صفحه دسته ها دسترسی پیدا کنید .
2. مکان نما خود را بر روی دسته ای که می خواهید ویرایش کنید برای نمایش منوی Actions قرار دهید.
3. کلیک کنید حذف کنید .
4. برای تایید روی Delete کلیک کنید.

حلقه کردن

برای حذف یک دسته :

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 . شناسه دسته را با دستور لیست API دسته بندی دریافت کنید.
• ACCESS_TOKEN با نشانه تأیید اعتبار مورد استفاده برای دسترسی به API Apigee Edge. برای کسب اطلاعات بیشتر در مورد تأیید اعتبار و نشانه ها ، به Authenticate Access به Edge API مراجعه کنید.

پاسخ بار پاسخ:

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