ניהול מוצרי API

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

ניהול של מוצרי ה-API באמצעות ממשק המשתמש לניהול של Apigee Edge, כמו שמתואר בקטע הזה. במאמר שימוש ב-Edge Management API לפרסום ממשקי API תוכלו לנהל את מוצר ה-API באמצעות ממשק ה-API.

בסרטון הבא מוסבר איך ליצור מוצר באמצעות API.

סקירה כללית על מוצרי ה-API זמינה במאמר מהו מוצר API?.

היכרות עם דף המוצרים של ה-API

נכנסים לדף המוצרים של ה-API כמו שמתואר בהמשך.

Edge

כדי לגשת לדף המוצרים של ה-API באמצעות ממשק המשתמש של Edge:

  1. נכנסים לחשבון בכתובת https://apigee.com/edge.
  2. בוחרים באפשרות פרסום > מוצרי API.

הדף 'מוצרי API' מוצג.

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

כפי שמתואר באיור הקודם, דף המוצרים בממשק ה-API מאפשר לבצע את המשימות הבאות, המתוארות בהמשך הקטע:

Classic Edge (ענן פרטי)

כדי לגשת לדף המוצרים של ה-API באמצעות ממשק המשתמש הקלאסי של Edge:

  1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
  2. בוחרים באפשרות פרסום > מוצרים.

דף המוצרים של ממשק ה-API מאפשר לבצע את המשימות הבאות, שמתוארות בהמשך הקטע:

הוספת מוצר API

מוסיפים מוצר API באמצעות ממשק המשתמש, כפי שמתואר בהמשך. אם רוצים להשתמש ב-Edge API, אפשר לקרוא את המאמר הגדרת מוצרי API באמצעות API.

כדי להוסיף מוצר API באמצעות ממשק המשתמש של Edge:

  1. נכנסים לדף המוצרים של ה-API, כמו שהוסבר קודם בקטע הזה.
  2. לוחצים על +מוצר API.
  3. יש להזין את פרטי המוצר של מוצר ה-API שלך.
    שדה התיאור
    שם שם פנימי של מוצר ה-API. לא ניתן לערוך את השם לאחר יצירת מוצר ה-API. אין לציין תווים מיוחדים בשם.
    השם המוצג השם המוצג של מוצר ה-API. השם המוצג מופיע בממשק המשתמש, ואפשר לערוך אותו בכל שלב. אם לא יצוין ערך, המערכת תשתמש בערך 'שם'. שדה זה מתמלא באופן אוטומטי באמצעות הערך 'שם'. ניתן לערוך או למחוק את התוכן שלו. השם המוצג יכול לכלול תווים מיוחדים.
    התיאור תיאור המוצר של ה-API.
    סביבה סביבות שאליהן מוצר ה-API יאפשר גישה. לדוגמה, test או prod.
    גישה רמת גישה. מידע נוסף מופיע במאמר בנושא רמת גישה.
    אישור אוטומטי של בקשות גישה יש להפעיל אישור אוטומטי של בקשות מפתח למוצר ה-API הזה מכל אפליקציה. כדי לדרוש אישור ידני של מפתחות, יש להשבית את האפשרות הזו. למידע נוסף, ראו רישום אפליקציות וניהול מפתחות API (ממשק משתמש) ומפתחות אפליקציות למפתחים (API).
    מכסה מגבלת המכסה שאתם רוצים להתייחס אליה במדיניות המכסה. הזנת ערך מכסה לא אוכפת באופן אוטומטי הגבלות על מספר השיחות שניתן לבצע דרך המוצר. שרתי proxy של ה-API שאליהם המוצר מפנה חייבים לכלול את מדיניות המכסה כדי לאכוף את המכסה. מידע נוסף זמין במאמר מכסות.
    היקפי OAuth מותרים אם משתמשים ב-OAuth עם מוצר ה-API, צריך לאשר את ההיקפים של OAuth, כמו 'קריאה' או היקפים אחרים שאפליקציות ישלחו בקריאות ל-API. יש לציין היקפים מרובים כרשימה מופרדת בפסיקים. להצגת היקפים של OAuth.
  4. מוסיפים את משאבי ה-API שזמינים במוצר ה-API, כולל שרתי ה-proxy ונתיבי המשאבים של ה-API.

    לדוגמה, אם מוסיפים למוצר שרת proxy של ה-API "music" עם נתיב הבסיס /music, מוצר ה-API מאפשר קריאות ל-/music. עם זאת, אם רוצים שמוצר ה-API יאפשר גישה רק לנתיב המשאב venues, שיש לו URI של /music/venues, צריך להוסיף למוצר את נתיב המשאב /venues. במקרה כזה, אפשר לבצע שיחות אל /music/venues?name=paramount, אבל השיחות אל /music/artists?name=Jack%Johnson ייחסמו.

    יש להגדיר נתיב של משאב ספציפי או להגדיר את הנתיב הבסיסי ואת כל נתיבי המשנה האפשריים על ידי ציון הנתיב של המשאב כ-/. נתיב המשאב יכול לכלול את התווים הכלליים לחיפוש /** ו-/*. תו כללי לחיפוש בכוכבית כפולה מציין כי כל נתיבי המשנה של הנתיב הבסיסי נתמכים (אך לא נתיב הבסיס). כוכבית אחת מציינת שיש תמיכה במזהי URI ברמה אחת מתחת לנתיב הבסיס. אפשר לעיין בהגדרת ההתנהגות של נתיב המשאב של '/', '/*' ו-'/**', כפי שמתואר בהמשך הקטע.

    כדי להוסיף משאבי API:

    1. לוחצים על הוספת שרת proxy או על הוספת נתיב בקטע של משאבי ה-API.
    2. בוחרים אם להוסיף שרת proxy ל-API, נתיב או שרת proxy ונתיב של API.

      בעזרת הקטע 'הוספת משאב של משאב API', אפשר להוסיף שרת proxy ל-API, נתיב של משאב או את שניהם.

    3. צריך להוסיף שרת proxy ונתיבי משאבים אחד או יותר של API.

      שימו לב לנקודות הבאות:

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

      לדוגמה:

      המערכת מתעלמת מנתיב המשאב שהוחל על כל שרתי ה-proxy של ה-API ומנתיב המשאב הספציפי יותר

    4. לוחצים על הוספה או על הוספה והפעלה של עוד (כדי לציין משאבי API נוספים).
  5. (אופציונלי) משתמשים בקטע Apigee Remote service targets (יעדי שירות מרוחקים של Apigee) כדי לקשר את המוצר ליעד שירות מרוחק אחד או יותר. אפשר להתעלם מההגדרה הזאת אלא אם משתמשים ב-Apigee Envoy Adapter. מידע נוסף זמין במדריך התפעול של Apigee Envoy Adapter.
  6. (אופציונלי) אפשר להשתמש בקטע מאפיינים מותאמים אישית כדי להוסיף עד 18 מאפיינים מותאמים אישית למוצר API.

    מאפיינים מותאמים אישית הם צמדי מפתח/ערך שאפשר להשתמש בהם בדרכים רבות, כולל עזרה בשליטה על ביצוע של שרת proxy ל-API. לדוגמה, אפשר ליצור מאפיין מותאם אישית בשם deprecated עם הערך True או False. בתהליך של שרת ה-proxy ל-API, אפשר לבדוק את הערך של המאפיין deprecated של המוצר של ה-API (לדוגמה, באמצעות המשתנה verifyapikey.{policy_name}.apiproduct.deprecated שזמין באופן אוטומטי אחרי שיוצרים את המאפיין המותאם אישית). אם הערך שלו TRUE (הוצא משימוש), יכול להיות שתוצג שגיאה במדיניות Raise Fault.

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

הגדרת ההתנהגות של נתיב משאב של '/', '/*' ו-'/**'

בטבלה הבאה מפורטת התנהגות ברירת המחדל של מוצר API עבור נתיבי משאבים שונים. בדוגמה הזו, לשרת proxy של ה-API יש נתיב בסיסי /v1/weatherapikey. נתיב המשאב של המוצר ב-API חל על סיומת הנתיב שאחרי הנתיב הבסיסי.

URI של בקשה מותר עבור / מותר עבור /* מותר עבור /** מותר עבור /*/2/** מותר עבור */*/2/*

/v1/weatherapikey

Y

לא

לא

לא

צ'

/v1/weatherapikey/

Y

לא

לא

לא

צ'

/v1/weatherapikey/1

Y

Y

כן

לא

צ'

/v1/weatherapikey/1/

Y

Y

כן

לא

צ'

/v1/weatherapikey/1/2

Y

לא

כן

לא

צ'

/v1/weatherapikey/1/2/

Y

לא

Y

כן

צ'

/v1/weatherapikey/1/2/3/

Y

לא

Y

Y

Y

/v1/weatherapikey/1/a/2/3/

Y

לא

כן

לא

צ'

כברירת מחדל, נתיב משאב / במוצר API תומך בנתיב הבסיסי ובכל נתיבי המשנה. לדוגמה, אם הנתיב הבסיסי של שרת ה-API של ה-API הוא /v1/weatherapikey, אז מוצר ה-API תומך בבקשות ל-/v1/weatherapikey ולכל נתיבי משנה כמו /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA וכו'.

אפשר לשנות את ברירת המחדל הזו כך שנתיב המשאב של / יתאים רק לנתיב הבסיס של שרת ה-API של ה-API. כלומר, מוצר ה-API לא יאפשר גישה ל-URI שמכיל כל מה שמופיע אחרי /. אם מבצעים את השינוי הזה, בטבלה שלמעלה רק שתי השורות הראשונות בקטע 'Allowed for /' יכילו את הערך 'Y'.

כדי לשנות את ברירת המחדל, אדמין צריך להגדיר בארגון את הערך של המאפיין features.isSingleForwardSlashBlockingEnabled ל-true. לקוחות Cloud יכולים לשלוח את הבקשה לתמיכה של Apigee Edge.

עריכת מוצר API

כדי לערוך מוצר API:

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

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

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

באמצעות Apigee Edge ל-Public Cloud, Edge שומר את הישויות הבאות במטמון למשך 180 שניות לפחות אחרי גישה לישויות.

  • אסימוני גישה מסוג OAuth. המשמעות היא שאסימון שבוטל יוכל בכל זאת לפעול במשך עד שלוש דקות, עד שיפוג התוקף של מגבלת המטמון שלו.
  • ישויות של שירות ניהול מפתחות (KMS) (אפליקציות, מפתחים, מוצרי API).
  • מאפיינים מותאמים אישית באסימוני OAuth וישויות KMS.

מחיקה של מוצר API

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

כדי למחוק מוצר API:

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