ניהול מוצרי API

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

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

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

עיון בדף המוצרים של ה-API

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

הוספת מוצר API

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

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

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

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

4. מוסיפים את משאבי ה-API שזמינים במוצר ה-API, כולל שרתי ה-proxy ל-API ונתיבי המשאבים.

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

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

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

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

      

   3. מוסיפים פרוקסי אחד או יותר של API ונתיבי משאבים.

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

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

      לדוגמה:

      

   4. לוחצים על הוספה או על הוספה והתחלה של עוד (כדי לציין עוד משאבי API).
5. (אופציונלי) משתמשים בקטע Apigee remote service targets כדי לקשר את המוצר ליעד שירות מרוחק אחד או יותר. אפשר להתעלם מההגדרה הזו, אלא אם אתם משתמשים ב-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 חל על הסיומת של נתיב כתובת ה-URL אחרי נתיב הבסיס.

‫URI של בקשה	מותר עבור /	Allowed for /*	מותר עבור /**	מותר ל-‎ /*/2/**	מותר לשימוש ב-‎ /*/2/*
/v1/weatherapikey	Y	לא	לא	לא	לא
/v1/weatherapikey/	Y	לא	לא	לא	לא
/v1/weatherapikey/1	Y	כן	כן	לא	לא
/v1/weatherapikey/1/	Y	כן	כן	לא	לא
/v1/weatherapikey/1/2	Y	לא	כן	לא	לא
/v1/weatherapikey/1/2/	Y	לא	כן	כן	לא
/v1/weatherapikey/1/2/3/	Y	לא	כן	כן	Y
/v1/weatherapikey/1/a/2/3/	Y	לא	כן	לא	לא

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

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

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

עריכת מוצר API

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

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

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

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

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

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

מחיקת מוצר API

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

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

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