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

ממשק משתמש

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

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

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

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

• הצגת הפרטים של ממשקי ה-API שזמינים בפורטל
• הוספת API לפורטל
• כדי לערוך API בפורטל, מבצעים משימה אחת או יותר מהמשימות הבאות:
  • ניהול תמונת מצב של מסמך שמשויך למוצר API כדי לעדכן את מאמרי העזרה של ה-API
  • פרסום או ביטול פרסום של API בפורטל
  • ניהול החשיפה של API בפורטל:
  • ניהול כתובת ה-URL לקריאה חוזרת (callback) של 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.

הוראות לשימוש בהחלפה בין דפים במטען הייעודי (payload) של התגובה מופיעות במאמר הערות לגבי החלפה בין דפים.

מטען ייעודי (payload) של התגובה:

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

  מטען ייעודי (payload) של התגובה:

  {
    "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 details.

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

   שדה	תיאור
   פורסם	בוחרים באפשרות Published (פורסם) כדי לפרסם את ה-API בפורטל. אם אתם לא מוכנים לפרסם את ה-API, מבטלים את הסימון בתיבת הסימון. אפשר לשנות את ההגדרה הזו מאוחר יותר, כמו שמתואר במאמר בנושא פרסום או ביטול פרסום של API בפורטל.
   כותרת לתצוגה	מעדכנים את השם של ה-API שמוצג בקטלוג. כברירת מחדל, המערכת משתמשת בשם מוצר ה-API. אפשר לשנות את השם המוצג מאוחר יותר, כמו שמתואר במאמר עריכת השם המוצג והתיאור.
   תיאור התצוגה	מעדכנים את התיאור של ה-API שמוצג בקטלוג. כברירת מחדל, המערכת משתמשת בתיאור של מוצר ה-API. אפשר לשנות את התיאור המוצג מאוחר יותר, כמו שמתואר במאמר עריכת השם והתיאור המוצגים.
   דרישה ממפתחים לציין כתובת URL לקריאה חוזרת (callback)	מפעילים את האפשרות הזו אם רוצים לדרוש ממפתחי אפליקציות לציין כתובת URL של קריאה חוזרת (callback). אפשר להוסיף או לעדכן את כתובת ה-URL לקריאה חוזרת (callback) בשלב מאוחר יותר, כמו שמתואר במאמר ניהול כתובת ה-URL לקריאה חוזרת (callback) עבור API.
   תיעוד ממשק API	כדי להשתמש במסמך OpenAPI: בוחרים באפשרות מסמך OpenAPI. לוחצים על בחירת מסמך. מבצעים אחת מהפעולות הבאות: לוחצים על הכרטיסייה המאפיינים שלי ובוחרים מאפיין מחנות המאפיינים. לוחצים על הכרטיסייה העלאת קובץ ומעלים קובץ. לוחצים על הכרטיסייה ייבוא מכתובת URL ומייבאים מפרט מכתובת URL. לוחצים על בחירה. כדי להשתמש בסכימת GraphQL: בוחרים באפשרות GraphQL Schema. לוחצים על בחירת מסמך. עוברים אל סכימת GraphQL ובוחרים בה. לוחצים על בחירה. לחלופין, אפשר לבחור באפשרות No documentation ולהוסיף מסמך מאוחר יותר אחרי הוספת ה-API, כמו שמתואר במאמר ניהול תמונת המצב של המסמך.
   הרשאות גישה ל-API	אם לא נרשמתם לגרסת הבטא של התכונה לניהול קהלים, אתם צריכים לבחור באחת מהאפשרויות הבאות: משתמשים אנונימיים כדי לאפשר לכל המשתמשים לצפות ב-API. משתמשים רשומים כדי לאפשר רק למשתמשים רשומים לצפות ב-API. אם נרשמתם לגרסת הבטא של התכונה לניהול קהלים, אתם יכולים לבחור באחת מהאפשרויות הבאות: גלוי לכולם כדי לאפשר לכל המשתמשים לצפות ב-API. משתמשים מאומתים כדי לאפשר רק למשתמשים רשומים לצפות ב-API. קהלים נבחרים כדי לבחור את הקהלים הספציפיים שרוצים שיוכלו לראות את ה-API. אפשר לשנות את הרשאות הגישה לקהל מאוחר יותר, כמו שמתואר במאמר בנושא ניהול הרשאות הגישה ל-API בפורטל.
   תמונה לתצוגה	כדי להציג תמונה בכרטיס ה-API בדף APIs, לוחצים על Select image (בחירת תמונה). בתיבת הדו-שיח בחירת תמונה, בוחרים תמונה קיימת, מעלים תמונה חדשה או מציינים את כתובת ה-URL של תמונה חיצונית, ולוחצים על בחירה. בודקים את התמונה הממוזערת של ה-API ולוחצים על בחירה. אפשר להוסיף תמונה מאוחר יותר, כמו שמתואר במאמר ניהול התמונה בכרטיס API. כשמציינים תמונה עם כתובת URL חיצונית, התמונה לא מועלית לנכסים שלכם. בנוסף, טעינת התמונה בפורטל המשולב תהיה תלויה בזמינות שלה, והיא עשויה להיחסם או להיות מוגבלת על ידי מדיניות אבטחת תוכן.
   קטגוריות	מוסיפים את הקטגוריות שבהן ה-API יתויג כדי שמפתחי אפליקציות יוכלו למצוא ממשקי API קשורים בדף APIs. כדי לזהות קטגוריה: בוחרים קטגוריה מהרשימה הנפתחת. כדי להוסיף קטגוריה חדשה, מקלידים את השם שלה ומקישים על Enter. הקטגוריה החדשה תתווסף לדף Categories (קטגוריות) ותהיה זמינה כשמוסיפים או עורכים ממשקי 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.

מטען ייעודי (payload) של התגובה:

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

   מטען ייעודי (payload) של התגובה:

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

   מטען ייעודי (payload) של התגובה:

   {
     "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 מופיעה דוגמה מפורטת של השלבים, המשתנים והמטען הייעודי (payload) שמוחזרים.

ממשק משתמש

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

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

ממשק משתמש

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

ממשק משתמש

כדי לתייג API לקטגוריות כשעורכים את ה-API:

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

ממשק משתמש

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

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 מופיעה דוגמה מפורטת של השלבים, המשתנים והמטען הייעודי (payload) שמוחזרים.

ממשק משתמש

כדי להסיר 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.

מטען ייעודי (payload) של התגובה:

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

ממשק משתמש

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

הפניית API מוצגת מהמסמך ונוספת לדף API Reference. סטטוס התמונה יתעדכן ל'נוכחי':

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.

  מטען ייעודי (payload) של התגובה:

{
  "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, בוחרים באפשרות 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.

מטען ייעודי (payload) של התגובה:

{
  "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 בקטלוג ה-API מוצגת רשימת הקטגוריות שהוגדרו לפורטל.

כפי שמודגש באיור הקודם, הדף 'ממשקי API' מאפשר לכם:

• הצגת הקטגוריות וממשקי ה-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.

מטען ייעודי (payload) של התגובה:

{
  "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

כדי להוסיף קטגוריה:

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.

מטען ייעודי (payload) של התגובה:

{
  "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. מוסיפים או מסירים תיוגים של ממשקי 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.

מטען ייעודי (payload) של התגובה:

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

ממשק משתמש

כדי למחוק קטגוריה:

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

curl

כדי למחוק קטגוריה:

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

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

• ‫ORG_NAME עם שם הארגון. לדוגמה, my-org.
• ‫SITE_ID עם שם הפורטל, בפורמט ORG_NAME-PORTAL_NAME, כאשר ORG_NAME הוא שם הארגון ו-PORTAL_NAME הוא שם הפורטל שהומר לאותיות קטנות בלבד, והוסרו ממנו רווחים ומקפים. לדוגמה, my-org-myportal.
• ‫CATEGORY_ID במזהה הקטגוריה. לדוגמה, bf6505eb-2a0f-47af-a00a-ded40ac72960. מריצים את הפקודה list API categories כדי לקבל את מזהה הקטגוריה.
• ‫ACCESS_TOKEN עם אסימון האימות שמשמש לגישה אל Apigee Edge API. מידע נוסף על אימות ואסימונים זמין במאמר אימות גישה ל-Edge API.

מטען ייעודי (payload) של התגובה:

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