שליטה בגישה לממשקי ה-API באמצעות רישום אפליקציות

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

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

סקירה כללית

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

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

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

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

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

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

אתם צריכים להיות אדמינים בארגון או להיות משויכים לתפקיד עם ההרשאות המתאימות כדי לרשום אפליקציות ולנהל מפתחות API.

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

הכרת הדף 'אפליקציות'

כדי להציג ולרשום אפליקציות ולנהל מפתחות API בממשק המשתמש של Apigee, משתמשים בתצוגה Apps.

נכנסים לדף Distribution > Apps במסוף Apigee ב-Cloud:

מעבר אל 'אפליקציות'

בתצוגה Apps אפשר:

• רישום אפליקציה
• הצגה ועריכה של אפליקציה
• ניהול פרטי הכניסה
• אישור או ביטול של אפליקציה
• מחיקת אפליקציה
• חיפוש ברשימת האפליקציות לפי שם, מפתח, מזהה אפליקציה, מפתח API של צרכן או כל התוכן

הערה: ככל שמספר האפליקציות הכולל גדל, זמני האחזור של זמן הטעינה בתצוגה Apps מתארכים. כדאי להשתמש במסננים כדי לצמצם את רשימת האפליקציות ולשפר את זמני הטעינה.

רישום אפליקציה

אזהרה: חשוב לוודא שהאפליקציה כוללת תמיד לפחות מוצר API אחד שבו מצוין לפחות proxy ל-API אחד או נתיב משאב אחד. אם מוצר ה-API לא כולל proxy ל-API או נתיב משאב, אפשר להשתמש במפתח של האפליקציה כדי לקרוא לכל proxy ל-API בארגון Apigee. ברוב המקרים, לא כדאי ליצור מה שנקרא מפתח אוניברסלי – מפתח שיכול לפתוח כל דלת בבית.

אפשר לרשום אפליקציה בדרכים הבאות:

• על ידי מפתח אפליקציה: מפתח אפליקציה יכול לרשום את האפליקציה דרך הפורטל שלכם, כפי שמתואר במאמר איך מפתחי אפליקציות יוצרים אינטראקציה עם הפורטל.
• על ידי אדמין: אפשר לרשום אפליקציה ב-Apigee, כמו שמתואר בהמשך. אתם קובעים איך לספק את המפתח למפתח האפליקציה.

אפליקציות רשומות נוספות אל:

• רשימת האפליקציות הרשומות ב-Apigee. איך צופים בפרטי המפתח ועורכים אותם
• דף האפליקציות בפורטל המפתחים.

כדי לרשום אפליקציה ב-Apigee:

1. עוברים לדף הפצה > אפליקציות:

   מעבר אל 'אפליקציות'

2. לוחצים על יצירה.
3. מציינים את פרטי האפליקציה, כפי שמתואר בטבלה הבאה:

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

   הערה: פרטי האפליקציה כוללים גם מזהה אפליקציה שאפשר לראות ולערוך רק דרך ה-API, ולא דרך ממשק המשתמש. אפשר לעיין במאמר בנושא משאב REST: organizations.developers.apps.
4. מציינים את פרטי הכניסה, כולל התפוגה והסטטוס של מפתח ה-API ומוצרי ה-API המשויכים. בקטע Credentials (פרטי כניסה), לוחצים על Add credential (הוספת פרטי כניסה) ומזינים את הפרטים הבאים:

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

5. מגדירים את הסטטוס כ'אושר' או כ'בוטל' לכל מוצר API. אם הוספתם מוצר API לפרטי הכניסה שדורשים אישור ידני, הוא יופיע עם הסמל Pending approval status. אחרת, יוצג התאריך Approved. בשלב הזה אפשר לשנות את סטטוס האישור.
   1. ברשימת המוצרים בקטע פרטי הכניסה, בוחרים מוצר אחד או יותר מהרשימה.
   2. לוחצים על אישור או על ביטול.
6. מציינים את המאפיינים המותאמים אישית:
   1. בקטע 'מאפיינים מותאמים אישית', לוחצים על הוספת מאפיין.
   2. מזינים את השם והערך.
   3. לוחצים על הוספת מאפיין. כדי להוסיף עוד מאפיינים. אפשר להוסיף עד 18 מאפיינים מותאמים אישית.
7. לוחצים על יצירה.

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

הצגת אפליקציות שרשומות למפתח

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

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

צפייה באפליקציה ועריכה שלה

הערה: לפני שאתם עורכים מאפיינים מותאמים אישית, ודאו שאין תלות במערכת בהגדרות הקיימות של המאפיינים.

‫Apigee שומר את הישויות הבאות במטמון למשך 180 שניות לפחות אחרי הגישה לישויות.

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

כדי להציג ולערוך אפליקציה:

1. עוברים לדף הפצה > אפליקציות:

   מעבר אל 'אפליקציות'

2. לוחצים בכל מקום בשורה של האפליקציה שרוצים לראות ולערוך. ‫Apigee מציג את פרטי האפליקציה.
   הערה: אפליקציות שמשויכות לקבוצות אפליקציות מוצגות גם הן ברשימת התוצאות. אתם יכולים לראות את פרטי האפליקציה ולמחוק אפליקציות של AppGroup, אבל לא ליצור או לערוך אותן בתצוגה הזו. הוראות לניהול קבוצות אפליקציות ואפליקציות בקבוצות אפליקציות זמינות במאמר שימוש בקבוצות אפליקציות כדי לארגן את הבעלות על אפליקציות.
3. כדי לערוך אפליקציה, לוחצים על עריכה.
4. מבצעים אחת או יותר מהמשימות הבאות:
   • משנים את פרטי האפליקציה, כולל השם, כתובת ה-URL של הקריאה החוזרת או ההערות.
   • ניהול פרטי הכניסה והמוצרים המשויכים.
   • הוספה או מחיקה של מאפיינים מותאמים אישית. אפשר להוסיף עד 18 מאפיינים מותאמים אישית.
   • אישור או ביטול אישור של האפליקציה.
5. לוחצים על Save.

ניהול פרטי הכניסה

כשעורכים אפליקציה, אפשר לנהל את פרטי הכניסה שלה בקטע פרטי כניסה. בממשק המשתמש אפשר לבצע את המשימות הבאות:

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

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

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

איך רואים מפתח API וסוד

כדי לראות מפתח API ו-API Secret:

1. עוברים לדף הפצה > אפליקציות:

   מעבר אל 'אפליקציות'

2. לוחצים בשורה של האפליקציה שרוצים לראות את מפתח ה-API ואת ה-Secret שלה.
3. בקטע Credentials, לוחצים על הסמל שמשויך למפתח ה-API או לסוד שרוצים לראות.

אישור או ביטול של מפתח API

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

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

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

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

1. עוברים לדף הפצה > אפליקציות:

   מעבר אל 'אפליקציות'

2. לוחצים בשורה של האפליקציה שרוצים לראות ולערוך.
3. לוחצים על עריכה.
4. כדי לאשר או לבטל מפתח API, בוחרים באפשרות Approved או Revoked בקטע Status של פרטי הכניסה.
5. לוחצים על Save.

ניהול מוצרי API באפליקציה

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

• הוספת מוצר API לאפליקציה
• הסרת מוצר API מאפליקציה

הוספה של מוצר API לאפליקציה

כדי להוסיף מוצר API לאפליקציה:

1. עוברים לדף הפצה > אפליקציות:

   מעבר אל 'אפליקציות'

2. לוחצים בשורה של האפליקציה שרוצים לראות ולערוך.
3. לוחצים על עריכה.
4. מבצעים אחת מהמשימות הבאות:
   • כדי להוסיף מוצר API למפתח API חדש, לוחצים על הוספת אמצעי אימות כדי ליצור אמצעי אימות חדש, בוחרים תאריך תפוגה ומוסיפים את מוצר ה-API למפתח ה-API.
   • כדי להוסיף מוצר או מוצרים של API למפתח API קיים, בקטע Credential (אישורים) לוחצים על Add products (הוספת מוצרים) ובוחרים מוצר או מוצרים של API מהתפריט הנפתח.
5. לוחצים על Save.

ביטול או הסרה של מוצר API מפרטי כניסה של אפליקציה

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

1. עוברים לדף הפצה > אפליקציות:

   מעבר אל 'אפליקציות'

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

אפשר לאשר מחדש מוצר API שבוטל או להוסיף מחדש מוצר API שהוסר.

יצירת פרטי כניסה חדשים

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

כדי ליצור מפתח API חדש:

1. עוברים לדף הפצה > אפליקציות:

   מעבר אל 'אפליקציות'

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

אישור או ביטול של אפליקציה

הערה: אפשר לאשר או לבטל אפליקציות שמשויכות למשתמש מסוים, כמו שמתואר במאמר ניהול משתמשי הפורטל

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

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

כדי לאשר או לבטל את הגישה של אפליקציה:

1. עוברים לדף הפצה > אפליקציות:

   מעבר אל 'אפליקציות'

2. לוחצים בשורה של האפליקציה שרוצים לראות ולערוך.
3. לוחצים על Edit.
4. בשדה סטטוס האפליקציה, לוחצים על אישור או על ביטול כדי לאשר את האפליקציה או לבטל את האישור שלה.
5. לוחצים על Save.

מחיקת אפליקציה

כשמוחקים אפליקציה, כל מפתחות הלקוח שמשויכים לאפליקציה הופכים ללא תקפים. שימוש במפתח לא תקין בבקשה גורם לכך שהבקשה תיכשל.

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

כדי למחוק אפליקציה:

1. עוברים לדף הפצה > אפליקציות:

   מעבר אל 'אפליקציות'

2. מציבים את הסמן בשורה של האפליקציה שרוצים למחוק.
3. לוחצים על עוד מחיקה בעמודה פעולות.

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

רישום אפליקציות וניהול מפתחות API באמצעות ה-API

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

• Apps API
• Developer apps API
• ‫Developer app keys API

אפשר גם לקרוא על ייבוא של מפתחות וסודות קיימים של צרכנים.