انتشار میاناهای برنامه‌سازی کاربردی

رابط کاربری

برای مشاهده کاتالوگ میانای برنامه‌سازی کاربردی:

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

زبانه «میاناهای برنامه‌سازی کاربردی» در کاتالوگ میانای برنامه‌سازی کاربردی فهرستی از میاناهای برنامه‌سازی کاربردی را که به درگاهتان اضافه شده‌اند نمایش می‌دهد.

همان‌طور که در شکل قبلی برجسته شده است، زبانه «میاناهای برنامه‌سازی کاربردی» به شما امکان می‌دهد:

• جزئیات میاناهای برنامه‌سازی کاربردی موجود در درگاهتان را مشاهده کنید
• افزودن میانای برنامه‌سازی کاربردی به درگاه
• با انجام یک یا چند مورد از وظایف زیر، یک API را در درگاهتان ویرایش کنید:
  • مدیریت کردن چیدمان لحظه‌ای سند منسوب به محصول API برای به‌روزرسانی اسناد مرجع API
  • انتشار یا لغو انتشار یک API در درگاه خود
  • مدیریت رؤیت‌پذیری یک API در درگاه:
  • مدیریت نشانی وب تماس برگشتی برای میانای برنامه‌سازی کاربردی
  • مدیریت تصویر کارت میانای برنامه‌سازی کاربردی
  • برچسب‌گذاری میانای برنامه‌سازی کاربردی بااستفاده از دسته‌ها
  • ویرایش عنوان و شرح API
• برداشتن یک API از درگاه
• مدیریت دسته‌های مورداستفاده برای کاوش میاناهای برنامه‌سازی کاربردی مرتبط
• به‌سرعت مشخصات قدیمی یا مشخصاتی را که از فروشگاه مشخصات حذف شده‌اند شناسایی کنید
• به‌سرعت میاناهای برنامه‌سازی کاربردی یتیم را که محصول API مرتبط آن‌ها از Apigee Edge برداشته شده است شناسایی کنید و محصول 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 استفاده می‌شود. برای اطلاعات بیشتر درباره اصالت‌سنجی و کدها، اصالت‌سنجی دسترسی به 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 برای مشخص کردن تعداد عناصر فهرست برای برگرداندن در یک صفحه استفاده کنید. مقدار پیش‌فرض ۲۵ و حداکثر مقدار ۱۰۰ است. اگر صفحه‌های اضافی وجود داشته باشد، 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 با تعداد موارد فهرست برای برگرداندن در یک صفحه. برای مثال، ۱۰.

  پایه‌بار پاسخ:

  {
    "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 با تعداد موارد فهرست برای برگرداندن در یک صفحه. برای مثال، ۱۰.
  • ‫PAGE_TOKEN با مقدار nextPageToken. برای مثال، 7zcqrin9l6xhi4nbrb9.

رابط کاربری

برای افزودن یک API به درگاه خود:

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

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

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

4. محصول API موردنظرتان را برای افزودن به درگاه انتخاب کنید.

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

6. محتوای اسناد مرجع میانای برنامه‌سازی کاربردی و رؤیت‌پذیری آن را در درگاه پیکربندی کنید:

   فیلد	شرح
   منتشرشده	برای انتشار API در درگاهتان، منتشرشده را انتخاب کنید. اگر آماده انتشار «میانای برنامه‌سازی کاربردی» نیستید، چارگوش انتخاب را پاک کنید. بعداً می‌توانید تنظیمات را تغییر دهید، همان‌طور که در انتشار یا لغو انتشار API در درگاه توضیح داده شده است.
   عنوان نمایشی	عنوان API خود را که در کاتالوگ نمایش داده می‌شود به‌روز کنید. به‌طور پیش‌فرض، از نام محصول API استفاده می‌شود. بعداً می‌توانید عنوان نمایش را تغییر دهید، همان‌طور که در ویرایش عنوان نمایش و شرح توضیح داده شده است.
   شرح آگهی‌های تصویری	شرح میانای برنامه‌سازی کاربردی خود را که در کاتالوگ نمایش داده می‌شود به‌روز کنید. به‌طور پیش‌فرض، از شرح محصول API استفاده می‌شود. می‌توانید شرح نمایش را بعداً تغییر دهید، همان‌طور که در ویرایش عنوان و شرح نمایش توضیح داده شده است.
   توسعه‌دهندگان ملزم شوند نشانی وب برگشتی را مشخص کنند	اگر می‌خواهید توسعه‌دهندگان برنامه ملزم شوند نشانی وب برگشتی را مشخص کنند، فعال کنید. می‌توانید نشانی وب تماس برگشتی را بعداً اضافه یا به‌روز کنید، همان‌طور که در مدیریت نشانی وب تماس برگشتی برای یک API توضیح داده شده است.
   اسناد API	برای استفاده از سند OpenAPI: سند Open API را انتخاب کنید. روی انتخاب سند کلیک کنید. یکی از مراحل زیر را انجام دهید: روی برگه مشخصات من کلیک کنید و مشخصاتی را از فروشگاه مشخصات انتخاب کنید. روی برگه بارگذاری فایل کلیک کنید و فایلی را بارگذاری کنید. روی برگه وارد کردن از نشانی وب کلیک کنید و مشخصات را از نشانی وب وارد کنید. روی انتخاب کلیک کنید. برای استفاده از طرحواره GraphQL: طرحواره GraphQL را انتخاب کنید. روی انتخاب سند کلیک کنید. به طرحواره GraphQL پیمایش کنید و آن را انتخاب کنید. روی انتخاب کلیک کنید. یا می‌توانید بدون سند را انتخاب کنید و پس‌از اضافه شدن API، طبق آنچه در مدیریت کردن نمای لحظه‌ای سند توضیح داده شده است، سندی اضافه کنید.
   رؤیت‌پذیری میانای برنامه‌سازی کاربردی	اگر در نسخه بتای ویژگی مدیریت مخاطب ثبت‌نام نکرده‌اید، یکی از گزینه‌های زیر را انتخاب کنید: کاربران ناشناس برای اجازه دادن به همه کاربران برای مشاهده API. کاربران ثبت‌شده برای اینکه فقط کاربران ثبت‌شده بتوانند API را ببینند. اگر در نسخه بتای ویژگی مدیریت مخاطب ثبت‌نام کرده‌اید، یکی از گزینه‌های زیر را انتخاب کنید: عمومی (برای همه قابل‌مشاهده است) تا به همه کاربران اجازه دهد «میانای برنامه‌سازی کاربردی» را مشاهده کنند. کاربران اصیل برای اینکه فقط کاربران ثبت‌شده بتوانند API را ببینند. مخاطبان انتخاب‌شده برای انتخاب مخاطبان خاصی که می‌خواهید بتوانند API را مشاهده کنند. بعداً می‌توانید رؤیت‌پذیری مخاطب را همان‌طور که در مدیریت رؤیت‌پذیری یک API در درگاه توضیح داده شده است مدیریت کنید.
   نمایش تصویر	برای نمایش تصویر در کارت API در صفحه APIs، روی انتخاب تصویر کلیک کنید. در چارگوش انتخاب تصویر، تصویر موجودی را انتخاب کنید، تصویر جدیدی بارگذاری کنید، یا نشانی وب تصویر خارجی را ارائه دهید، و روی انتخاب کلیک کنید. ریزعکس API را پیش‌نمایش کنید و روی انتخاب کلیک کنید. می‌توانید بعداً تصویری اضافه کنید، همان‌طور که در مدیریت تصویر برای کارت API توضیح داده شده است. هنگام مشخص کردن تصویر با نشانی وب خارجی، تصویر در دارایی‌های شما بارگذاری نخواهد شد؛ علاوه‌براین، بار کردن تصویر در درگاه یکپارچه منوط به دردسترس بودن آن است که ممکن است توسط خط‌مشی‌های امنیت محتوا مسدود یا محدود شود.
   دسته‌ها	دسته‌هایی را که میانای برنامه‌سازی کاربردی به آن‌ها برچسب‌گذاری می‌شود اضافه کنید تا توسعه‌دهندگان برنامه بتوانند میاناهای برنامه‌سازی کاربردی مرتبط را در صفحه «میاناهای برنامه‌سازی کاربردی» پیدا کنند. برای شناسایی یک دسته: دسته‌ای را از فهرست کرکره‌ای انتخاب کنید. با تایپ کردن نام دسته و فشار دادن کلید Enter، دسته جدیدی اضافه کنید. دسته جدید به صفحه «دسته‌ها» اضافه خواهد شد و هنگام افزودن یا ویرایش کردن دیگر میاناهای برنامه‌سازی کاربردی دردسترس قرار خواهد گرفت.

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 استفاده می‌شود. برای اطلاعات بیشتر درباره اصالت‌سنجی و کدها، اصالت‌سنجی دسترسی به Edge API را ببینید.
• ‫TITLE با عنوان نمایشی. برای مثال، Hello World 2.
• ‫DESCRIPTION با شرح نمایشگر. برای مثال، Simple hello world example.
• ‫ANON_TRUE_OR_FALSE با true یا false (پیش‌فرض)، که در آن true یعنی این API نمایان بودن عمومی دارد و می‌تواند به‌صورت ناشناس مشاهده شود؛ درغیراین‌صورت، فقط کاربران ثبت‌شده می‌توانند آن را مشاهده کنند.
• IMAGE_URL با نشانی وب تصویر خارجی مورداستفاده برای مورد کاتالوگ، یا مسیر فایل برای فایل‌های تصویری ذخیره‌شده در درگاه برای مثال، /files/book-tree.jpg. هنگام مشخص کردن نشانی وب تصویر خارجی، تصویر در دارایی‌هایتان بارگذاری نخواهد شد؛ علاوه‌براین، بار کردن تصویر در درگاه یکپارچه تابع دردسترس بودن آن خواهد بود، که ممکن است توسط خط‌مشی‌های امنیت محتوا مسدود یا محدود شود.
• CALLBACK_TRUE_OR_FALSE با true یا false (پیش‌فرض)، که در آن true کاربر درگاه را ملزم می‌کند هنگام مدیریت برنامه نشانی وب را وارد کند.
• CATEGORY_ID با شناسه دسته. برای مثال، bf6505eb-2a0f-47af-a00a-ded40ac72960. شناسه‌های دسته‌های متعدد را با ویرگول از هم جدا کنید. شناسه دسته را با فرمان فهرست دسته‌های میانای برنامه‌سازی کاربردی دریافت کنید.
• ‫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.

رابط کاربری

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

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

فر کردن

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

این مثال شما را با مراحل لازم برای تغییر وضعیت منتشرشده میانای برنامه‌سازی کاربردی در درگاهتان از true به false آشنا می‌کند. درصورت لزوم، می‌توانید بیش‌از یک تنظیم را در یک فراخوانی API تغییر دهید.

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. برای یافتن این مقدار، از فرمان فهرست کردن سندهای میانای برنامه‌سازی کاربردی استفاده کنید.
   • 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
   }
   

رابط کاربری

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

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

فر کردن

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

"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. اگر برگه 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

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

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

   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:

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

فر کردن

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

   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:

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

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

   • اگر تصویری انتخاب نشده است، روی انتخاب تصویر کلیک کنید تا تصویری را مشخص یا بارگذاری کنید.
   • برای مشخص کردن یا بارگذاری تصویر دیگری، روی تغییر تصویر کلیک کنید.
   • برای برداشتن تصویر، روی x در تصویر کلیک کنید.

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

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

فر کردن

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

   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. اگر برگه APIs ازقبل انتخاب نشده است، روی آن کلیک کنید.
3. در ردیف API که می‌خواهید ویرایش کنید کلیک کنید.
4. روی ویرایش کلیک کنید.
5. در فیلد دسته‌ها کلیک کنید و یکی از مراحل زیر را انجام دهید:
   • دسته‌ای را از فهرست کرکره‌ای انتخاب کنید.
   • با تایپ کردن نام دسته و فشار دادن کلید Enter، دسته جدیدی اضافه کنید. دسته جدید به صفحه «دسته‌ها» اضافه خواهد شد و هنگام افزودن یا ویرایش کردن دیگر میاناهای برنامه‌سازی کاربردی دردسترس قرار خواهد گرفت.
6. این کار را تکرار کنید تا «میانای برنامه‌سازی کاربردی» را به دسته‌های بیشتری برچسب بزنید.
7. روی ذخیره کلیک کنید.

فر کردن

موارد زیر را در update تماس بگنجانید:

  # Omit line for no categories

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

از فرمان فهرست دسته‌ها برای دریافت شماره‌های شناسه دسته استفاده کنید.

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

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

   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. اگر برگه APIs ازقبل انتخاب نشده است، روی آن کلیک کنید.
3. در ردیف API که می‌خواهید ویرایش کنید کلیک کنید.
4. روی ویرایش کلیک کنید.
5. فیلدهای عنوان نمایشی و شرح نمایشی را درصورت نیاز ویرایش کنید.
6. روی ذخیره کلیک کنید.

فر کردن

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

   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 از درگاه:

1. دسترسی به کاتالوگ میانای برنامه‌سازی کاربردی.
2. اگر APIs قبلاً انتخاب نشده است، آن را انتخاب کنید.
3. مکان‌نما را روی «میانای برنامه‌سازی کاربردی» در فهرست قرار دهید تا منو کنش‌ها نمایش داده شود.
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. برای یافتن این مقدار، از فرمان فهرست کردن سندهای میانای برنامه‌سازی کاربردی استفاده کنید.
• ACCESS_TOKEN با کد اصالت‌سنجی که برای دسترسی به میانای برنامه‌سازی کاربردی Apigee Edge استفاده می‌شود. برای اطلاعات بیشتر درباره اصالت‌سنجی و کدها، اصالت‌سنجی دسترسی به Edge API را ببینید.

پایه‌بار پاسخ:

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

رابط کاربری

1. دسترسی به کاتالوگ میانای برنامه‌سازی کاربردی.
2. اگر برگه APIs ازقبل انتخاب نشده است، روی آن کلیک کنید.
3. در ردیف API که می‌خواهید ویرایش کنید کلیک کنید.
4. وضعیت لحظه‌ای را بررسی کنید. اگر تاریخ آن قدیمی باشد، پیام زیر نمایش داده می‌شود:
5. روی edit ویرایش کلیک کنید.
6. یکی از کارهای زیر را انجام دهید:
   • برای بازآوری کردن عکس آنی سند OpenAPI که قدیمی است، روی بازآوری عکس آنی کلیک کنید.
   • برای تغییر سندی که برای تولید مستندات میانای برنامه‌سازی کاربردی استفاده می‌شود، در بخش «مستندات میانای برنامه‌سازی کاربردی» روی انتخاب سند کلیک کنید و سند جدید را انتخاب کنید.
7. در قاب مستندات API، یکی از موارد زیر را انتخاب کنید:
   • سند Open API
   • طرحواره GraphQL
8. روی انتخاب سند کلیک کنید و جدیدترین نسخه سند را انتخاب کنید.
9. برای GraphQL، نشانی وب نقطه پایان را مشخص کنید.
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
}

رابط کاربری

فر کردن

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

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. برای یافتن این مقدار، از فرمان فهرست کردن سندهای میانای برنامه‌سازی کاربردی استفاده کنید.

  پایه‌بار پاسخ:

{
  "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. اگر برگه APIs ازقبل انتخاب نشده است، روی آن کلیک کنید.
3. در ردیف API که می‌خواهید ویرایش کنید کلیک کنید.
4. روی edit ویرایش کلیک کنید.
5. در قاب مستندات API، بدون مستندات را انتخاب کنید.
6. روی ذخیره کلیک کنید.

فر کردن

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

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. برای یافتن این مقدار، از فرمان فهرست کردن سندهای میانای برنامه‌سازی کاربردی استفاده کنید.

پایه‌بار پاسخ:

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

رابط کاربری

برای مشاهده صفحه «دسته‌ها»:

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

   یا می‌توانید کاتالوگ API را در منوِ کرکره‌ای در نوار پیمایش بالا انتخاب کنید.

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

برگه دسته‌ها در کاتالوگ 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 با کد اصالت‌سنجی که برای دسترسی به میانای برنامه‌سازی کاربردی 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. به‌صورت اختیاری، یک یا چند 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 با کد اصالت‌سنجی که برای دسترسی به میانای برنامه‌سازی کاربردی 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 -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. شناسه‌های دسته‌های متعدد را با ویرگول از هم جدا کنید. شناسه دسته را با فرمان فهرست دسته‌های میانای برنامه‌سازی کاربردی دریافت کنید.
• 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 -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. شناسه دسته را با فرمان فهرست دسته‌های میانای برنامه‌سازی کاربردی دریافت کنید.
• ACCESS_TOKEN با کد اصالت‌سنجی که برای دسترسی به میانای برنامه‌سازی کاربردی Apigee Edge استفاده می‌شود. برای اطلاعات بیشتر درباره اصالت‌سنجی و کدها، اصالت‌سنجی دسترسی به Edge API را ببینید.

پایه‌بار پاسخ:

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