פרסום ממשקי ה-API

ממשק משתמש

כדי להציג את קטלוג ה-API:

1. בוחרים באפשרות פרסום > פורטלים ובוחרים את הפורטל.
2. לוחצים על API catalog בדף הבית של הפורטל. לחלופין, אפשר לבחור באפשרות API catalog בתפריט הנפתח של הפורטל בסרגל הניווט העליון.

בכרטיסייה APIs בקטלוג ה-API מוצגת רשימה של ממשקי ה-API שהוספתם לפורטל.

כפי שמודגש באיור הקודם, כרטיסיית ממשקי ה-API מאפשרת לכם:

• הצגת הפרטים של ממשקי ה-API שזמינים בפורטל
• הוספת ממשק API לפורטל
• כדי לערוך ממשק API בפורטל, מבצעים אחת או יותר מהמשימות הבאות:
  • ניהול קובץ snapshot של מסמך שמשויך למוצר API כדי לעדכן את מאמרי העזרה של ה-API
  • פרסום או ביטול פרסום של ממשק API בפורטל
  • ניהול החשיפה של ממשק API בפורטל:
  • ניהול כתובת ה-URL לקריאה חוזרת (callback) של API
  • ניהול התמונה של כרטיס API
  • תיוג ממשק API באמצעות קטגוריות
  • עריכת השם והתיאור של ה-API
• הסרת ממשק API מהפורטל
• ניהול הקטגוריות שבהן נעשה שימוש כדי למצוא ממשקי API קשורים
• זיהוי מהיר של מפרטי גרפיקה לא עדכניים או שנמחקו מחנות המפרטים
• לזהות במהירות ממשקי API יתומים שמוצרי ה-API המשויכים להם הוסרו מ-Apigee Edge, וליצור מחדש את מוצרי ה-API או למחוק את ממשקי ה-API מהפורטל

curl

כדי לציין רשימה של ממשקי 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.

ממשק משתמש

כדי להוסיף ממשק API לפורטל:

1. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.

3. לוחצים על + הוספה.

   תיבת הדו-שיח Add an API product to the catalog (הוספת מוצר API לקטלוג) תוצג.

4. בוחרים את מוצרי ה-API שרוצים להוסיף לפורטל.

5. לוחצים על הבא. יוצג הדף פרטי ה-API.

6. הגדרת התוכן של חומר העזר בנושא API והחשיפה שלו בפורטל:

   שדה	תיאור
   פורסם	בוחרים באפשרות Published (פורסם) כדי לפרסם את ה-API בפורטל. אם אתם לא מוכנים לפרסם את ה-API, מבטלים את הסימון בתיבה. תוכלו לשנות את ההגדרה מאוחר יותר, כפי שמתואר בקטע פרסום או ביטול פרסום של ממשק API בפורטל.
   כותרת לתצוגה	מעדכנים את השם של ה-API שמוצג בקטלוג. כברירת מחדל, המערכת משתמשת בשם המוצר של ה-API. תוכלו לשנות את השם המוצג מאוחר יותר, כפי שמתואר בקטע עריכת השם המוצג והתיאור.
   הצגת התיאור	מעדכנים את התיאור של ה-API שמוצג בקטלוג. כברירת מחדל, המערכת משתמשת בתיאור המוצר של ה-API. תוכלו לשנות את התיאור המוצג מאוחר יותר, כפי שמתואר בקטע עריכת השם והתיאור המוצגים.
   דרישה מהמפתחים לציין כתובת URL לקריאה חוזרת (callback)	מפעילים את האפשרות הזו אם רוצים לחייב את מפתחי האפליקציות לציין כתובת URL לקריאה חוזרת (callback). תוכלו להוסיף או לעדכן את כתובת ה-URL לקריאה חוזרת מאוחר יותר, כפי שמתואר במאמר ניהול כתובת ה-URL לקריאה חוזרת של API.
   תיעוד ממשק API	כדי להשתמש במסמך OpenAPI: בוחרים באפשרות מסמך OpenAPI. לוחצים על בחירת מסמך. מבצעים את אחת מהפעולות הבאות: לוחצים על הכרטיסייה My Specs (המפרטים שלי) ובוחרים מפרט מחנות המפרטים. לוחצים על הכרטיסייה Upload File (העלאת קובץ) ומעלים קובץ. לוחצים על הכרטיסייה ייבוא מכתובת URL וייבאים מפרט מכתובת URL. לוחצים על בחירה. כדי להשתמש בסכימה של GraphQL: בוחרים באפשרות GraphQL Schema. לוחצים על בחירת מסמך. עוברים אל הסכימה של GraphQL ובוחרים בה. לוחצים על בחירה. לחלופין, אפשר לבחור באפשרות No documentation ולהוסיף מסמך מאוחר יותר, אחרי הוספת ה-API, כפי שמתואר בקטע ניהול קובץ snapshot של המסמך.
   הרשאות גישה ל-API	אם לא נרשמתם לגרסת הבטא של התכונה 'ניהול קהלים', תוכלו לבחור באחת מהאפשרויות הבאות: משתמשים אנונימיים כדי לאפשר לכל המשתמשים להציג את ה-API. משתמשים רשומים כדי לאפשר רק למשתמשים רשומים להציג את ה-API. אם נרשמתם לגרסת הבטא של התכונה 'ניהול קהלים', תוכלו לבחור באחת מהאפשרויות הבאות: גלוי לכולם כדי לאפשר לכל המשתמשים להציג את ה-API. משתמשים מאומתים כדי לאפשר רק למשתמשים רשומים להציג את ה-API. קהלים נבחרים כדי לבחור את הקהלים הספציפיים שרוצים שיוכלו להציג את ה-API. תוכלו לנהל את הרשאות הגישה של הקהל בשלב מאוחר יותר, כפי שמתואר במאמר ניהול הרשאות הגישה של ממשק API בפורטל.
   תמונה לתצוגה	כדי להציג תמונה בכרטיס ה-API בדף הממשקים, לוחצים על בחירת תמונה. בתיבת הדו-שיח בחירת תמונה, בוחרים תמונה קיימת, מעלים תמונה חדשה או מספקים את כתובת ה-URL של תמונה חיצונית ולוחצים על בחירה. בודקים את התצוגה המקדימה של התמונה הממוזערת של ה-API ולוחצים על בחירה. אפשר להוסיף תמונה מאוחר יותר, כפי שמתואר בקטע ניהול התמונה של כרטיס API. כשמציינים תמונה עם כתובת URL חיצונית, התמונה לא תועלה לנכסים שלכם. בנוסף, טעינת התמונה בפורטל המשולב תלויה בזמינות שלה, שעשויה להיות חסומה או מוגבלת על ידי מדיניות אבטחת התוכן.
   קטגוריות	מוסיפים את הקטגוריות שבהן ה-API יסומן, כדי לאפשר למפתחי האפליקציות לגלות ממשקי API קשורים בדף APIs. כדי לזהות קטגוריה: בוחרים קטגוריה מהרשימה הנפתחת. כדי להוסיף קטגוריה חדשה, מקלידים את השם שלה ומקישים על Enter. הקטגוריה החדשה תתווסף לדף 'קטגוריות' ותהיה זמינה כשמוסיפים או עורכים ממשקי API אחרים.

7. לוחצים על שמירה.

curl

כדי להוסיף ממשק 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 categories.
• 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. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.
3. לוחצים על השורה של ממשק ה-API שרוצים לערוך.
4. לוחצים על עריכה.
5. מבצעים את השינויים הרצויים בקטע פרטי ה-API. תוכלו לקרוא תיאורים של האפשרויות בקטע הוספת API.
6. לוחצים על שמירה.

curl

אחרי שמוסיפים ממשק API, משתמשים בקריאה update כדי לבצע עריכות.

בדוגמה הזו מוסבר איך לשנות את סטטוס הפרסום של ה-API בפורטל מ-true ל-false. אם צריך, אפשר לשנות יותר מהגדרה אחת בקריאה אחת ל-API.

1. כדי לאתר את הערך של id שנוצר ומזהה באופן ייחודי כל API, צריך לקבל רשימה של ממשקי ה-API בפורטל, כפי שמתואר בקטע הצגת ממשקי API.

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. כוללים את הערכים שניתן לשינוי שרוצים לשמור בקריאה ל-update, ומשנים את הערכים שרוצים לשנות. אם משמיטים שורה, המערכת משתמשת בהגדרת ברירת המחדל. בדוגמה הזו, משנים את ההגדרה 'פורסם' מ-false ל-true:

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

   מחליפים את מה שכתוב בשדות הבאים:

   • TITLE עם השם המוצג. לדוגמה, Hello World 2.

   מטען התגובה:

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

ממשק משתמש

כדי לפרסם או לבטל את הפרסום של ממשק API בפורטל:

1. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.
3. לוחצים על השורה של ממשק ה-API שרוצים לערוך.
4. לוחצים על עריכה.
5. בקטע פרטי ה-API, בוחרים באפשרות פורסם (רשום בקטלוג) כדי לפרסם את ה-API בפורטל או לבטל את הפרסום שלו, בהתאמה.
6. לוחצים על שמירה.

curl

צריך לכלול את אחת מהאפשרויות הבאות בקריאה לעדכון:

"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. משתמשים בקריאה update כדי לערוך את ה-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
   }

במאמר ניהול הגרסה של המסמך מופיעה דוגמה מפורטת של השלבים, המשתנים ועומס העבודה (payload) שמוחזרים.

ממשק משתמש

כדי לנהל את החשיפה של ממשק API בפורטל:

1. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.
3. לוחצים על השורה של ממשק ה-API שרוצים לערוך.
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

כדי לערוך את ה-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 כדי לערוך את ה-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 מופיעה דוגמה מפורטת של השלבים, המשתנים ועומס העבודה המוחזר.

ממשק משתמש

כדי לנהל את כתובת ה-URL לקריאה חוזרת (callback) של ממשק API:

1. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.
3. לוחצים על השורה של ממשק ה-API שרוצים לערוך.
4. לוחצים על עריכה.
5. בקטע פרטי ה-API, מסמנים או מבטלים את הסימון של התיבה Require developers to specify a callback 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

כדי לערוך את ה-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 כדי לערוך את ה-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 מופיעה דוגמה מפורטת של השלבים, המשתנים ועומס העבודה המוחזר.

ממשק משתמש

כדי לנהל את התמונה של כרטיס API:

1. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.
3. לוחצים על השורה של ממשק ה-API שרוצים לערוך.
4. לוחצים על עריכה.

5. בקטע פרטי ה-API:

   • לוחצים על בחירת תמונה כדי לציין תמונה או להעלות תמונה, אם לא נבחרה תמונה.
   • לוחצים על שינוי התמונה כדי לציין תמונה אחרת או להעלות תמונה אחרת.
   • לוחצים על 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

כדי לערוך את ה-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 כדי לערוך את ה-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 מופיעה דוגמה מפורטת של השלבים, המשתנים ועומס העבודה המוחזר.

ממשק משתמש

כדי לתייג ממשק API לקטגוריות בזמן העריכה שלו:

1. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.
3. לוחצים על השורה של ממשק ה-API שרוצים לערוך.
4. לוחצים על עריכה.
5. לוחצים בתוך השדה Categories (קטגוריות) ומבצעים את אחד מהשלבים הבאים:
   • בוחרים קטגוריה מהרשימה הנפתחת.
   • כדי להוסיף קטגוריה חדשה, מקלידים את השם שלה ומקישים על Enter. הקטגוריה החדשה תתווסף לדף 'קטגוריות' ותהיה זמינה כשמוסיפים או עורכים ממשקי API אחרים.
6. חוזרים על הפעולה כדי לתייג את ה-API לקטגוריות נוספות.
7. לוחצים על שמירה.

curl

צריך לכלול את הפרטים הבאים בקריאה ל-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. משתמשים בקריאה update כדי לערוך את ה-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 מופיעה דוגמה מפורטת של השלבים, המשתנים ועומס העבודה המוחזר.

ממשק משתמש

כדי לערוך את הכותרת והתיאור של התצוגה:

1. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.
3. לוחצים על השורה של ממשק ה-API שרוצים לערוך.
4. לוחצים על עריכה.
5. עורכים את השדות השם המוצג והתיאור המוצג לפי הצורך.
6. לוחצים על שמירה.

curl

צריך לכלול את הפרטים הבאים בקריאה ל-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. משתמשים בקריאה update כדי לערוך את ה-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 מופיעה דוגמה מפורטת של השלבים, המשתנים ועומס העבודה המוחזר.

ממשק משתמש

כדי להסיר ממשק API מהפורטל:

1. כניסה לקטלוג ה-API
2. בוחרים את ממשקי ה-API, אם הם עדיין לא מסומנים.
3. מעבירים את הסמן מעל ה-API ברשימה כדי להציג את תפריט הפעולות.
4. לוחצים על מחיקה.

curl

כדי להסיר ממשק 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
}

ממשק משתמש

1. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.
3. לוחצים על השורה של ממשק ה-API שרוצים לערוך.
4. בודקים את סטטוס קובץ ה-snapshot. אם הוא לא מעודכן, תוצג ההודעה הבאה:
5. לוחצים על edit עריכה.
6. מבצעים אחת מהמשימות הבאות:
   • כדי לרענן קובץ snapshot של מסמך OpenAPI לא עדכני, לוחצים על Refresh Snapshot.
   • כדי לשנות את המסמך שמשמש ליצירת התיעוד של ה-API, בקטע API documentation לוחצים על Select Document ובוחרים את המסמך החדש.
7. בחלונית מאמרי העזרה של ה-API, בוחרים באחת מהאפשרויות הבאות:
   • מסמך OpenAPI
   • סכימת GraphQL
8. לוחצים על בחירת מסמך ובוחרים את הגרסה העדכנית ביותר של המסמך.
9. ב-GraphQL, מציינים את כתובת ה-URL של נקודת הקצה.
10. לוחצים על שמירה.

מאמרי העזרה של ה-API נוצרים מהמסמך ומתווספים לדף העזרה של ה-API. סטטוס קובץ ה-snapshot מתעדכן לסטטוס הנוכחי:

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

כדי להוריד את מסמכי התיעוד של ה-API באמצעות 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 של תוכן מסמכי התיעוד של ה-API.

ממשק משתמש

1. כניסה לקטלוג ה-API
2. לוחצים על הכרטיסייה APIs (ממשקי API) אם היא לא מסומנת.
3. לוחצים על השורה של ממשק ה-API שרוצים לערוך.
4. לוחצים על edit עריכה.
5. בחלונית API documentation, בוחרים באפשרות No documentation.
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. לוחצים על API catalog בדף הבית של הפורטל.

   לחלופין, אפשר לבחור באפשרות API catalog בתפריט הנפתח של הפורטל בסרגל הניווט העליון.

3. לוחצים על הכרטיסייה Categories.

בכרטיסייה Categories בקטלוג ה-API מוצגת רשימת הקטגוריות שהוגדרו בפורטל.

כפי שמודגש בתרשים הקודם, בדף APIs אפשר:

• הצגת הקטגוריות וממשקי ה-API שאליהם הם מתויגים
• להוספת קטגוריה
• עריכת קטגוריה
• מחיקת קטגוריה
• ניהול ממשקי ה-API שפורסמו בפורטל. מידע נוסף על קטלוג ה-API

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 API. מידע נוסף על אימות ואסימונים זמין במאמר אימות הגישה ל-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. נכנסים לדף Categories.
2. לוחצים על + הוספה.
3. מזינים את השם של הקטגוריה החדשה.
4. אפשר גם לבחור ממשק API אחד או יותר לתיוג לקטגוריה.
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 API. מידע נוסף על אימות ואסימונים זמין במאמר אימות הגישה ל-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. נכנסים לדף Categories.
2. לוחצים על עריכה.
3. עורכים את שם הקטגוריה.
4. מוסיפים או מסירים תגי API.
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 API. מידע נוסף על אימות ואסימונים זמין במאמר אימות הגישה ל-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. נכנסים לדף Categories.
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 API. מידע נוסף על אימות ואסימונים זמין במאמר אימות הגישה ל-Edge API.

מטען התגובה:

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