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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

מפתחים משתמשים בדף 'האפליקציות שלי' בפורטל Developer Services כדי לרשום אפליקציות. מפתחים ניגשים לדף 'האפליקציות שלי' מהתפריט הראשי של הפורטל:

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

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

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

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

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

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

• יצירת מוצרי API
• שימוש ב-Management API של Edge לפרסום ממשקי API

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

ציון מוצרי ה-API שזמינים בפורטל

יש שתי דרכים לציין את מוצרי ה-API שזמינים למפתחים כשהם נכנסים לפורטל:

• ציון רמת הגישה בזמן יצירת מוצר API
• הגבלת הגישה למוצרי API על סמך תפקידים

ציון רמת הגישה בזמן יצירת מוצר API

כשיוצרים מוצר API, מציינים את רמת הגישה של המוצר, כפי שמתואר בהמשך:

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

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

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

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

1. מתחברים לפורטל בתור משתמש עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. בודקים את התפקידים וההקצאות של המשתמשים בפורטל הפיתוח:
   • בתפריט הניהול של Drupal, בוחרים באפשרות People > Permissions > Roles ומוסיפים או עורכים את התפקידים וההרשאות של המפתחים, לפי הצורך.
   • בתפריט האדמין של Drupal, בוחרים באפשרות People ועורכים את ההקצאות של המשתמשים והתפקידים לפי הצורך.
3. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Dev Portal > API Product Role Access.
4. בוחרים את התפקידים שרוצים שיהיה להם גישה לכל מוצר API.
5. לוחצים על Save configuration.

הגדרת האופן שבו מפתח משייך מוצרי API לאפליקציה

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

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

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

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

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

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

כדי להגדיר את האפשרות לבחירת מוצרים ב-API:

1. מתחברים לפורטל בתור משתמש עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Dev Portal Settings > Application Settings.
3. בדף Application Settings (הגדרות האפליקציה), מרחיבים את האזור API Product settings (הגדרות של מוצרי API).
4. בקטע API Product Handling, בוחרים באפשרות ששולטת בבחירת מוצרי ה-API.
5. אם מציינים את האפשרות 'שיוך כל האפליקציות למוצר API אחד או יותר שמוגדר כברירת מחדל (הגדרה בהמשך)', צריך להגדיר מוצר ברירת מחדל בקטע Default API Product.
6. בקטע ווידג'ט של מוצרי API, בוחרים את רכיב ה-HTML שבו המפתחים משתמשים כדי לבחור את מוצרי ה-API.
7. שומרים את ההגדרה.

הגדרת הטיפול בכתובת URL לקריאה חוזרת (callback)

אם שרת proxy של API במוצר ה-API שלכם משתמש ב-'OAuth משולש' (סוג הענקת הרשאה של קוד הרשאה), המפתחים צריכים לציין כתובת URL של קריאה חוזרת (callback) כשהם רושמים את האפליקציות שלהם. כתובת ה-URL של הקריאה החוזרת בדרך כלל מציינת את כתובת ה-URL של אפליקציה שמוגדרת לקבל קוד הרשאה בשם אפליקציית הלקוח. בנוסף, מחרוזת כתובת ה-URL הזו משמשת לאימות. הלקוח צריך לשלוח את כתובת ה-URL הזו אל Apigee Edge כשמבקשים קודי הרשאה ואסימוני גישה, ופרמטר redirect_uri חייב להתאים לזה שרשום. למידע נוסף, ראו הטמעת סוג ההקצאה של קוד ההרשאה.

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

1. מתחברים לפורטל בתור משתמש עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Dev Portal Settings > Application Attributes.
3. בדף Application Settings (הגדרות האפליקציה), מרחיבים את האזור Callback URL settings (הגדרות של כתובת URL לקריאה חוזרת).
4. בקטע Callback URL Handling (טיפול בכתובת ה-URL של שיחה חוזרת), בוחרים באחת מהאפשרויות הבאות.
   • כתובת URL להודעת חזרה נדרשת לכל האפליקציות של המפתחים.
   • כתובת ה-URL לקריאה חוזרת (callback) היא אופציונלית לכל אפליקציות הפיתוח.
   • אין צורך בכתובת URL לקריאה חוזרת (callback) והיא לא מוצגת.
5. שומרים את ההגדרה.

הצגת ניתוח נתונים של השימוש באפליקציה

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

• תפוקה
• זמן תגובה מקסימלי
• זמן תגובה מינימלי
• מספר ההודעות
• מספר השגיאות

כדי להפעיל את ניתוח הנתונים בפורטל:

1. מתחברים לפורטל בתור משתמש עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Dev Portal > Application Settings.
3. בדף 'הגדרות האפליקציה', מרחיבים את האזור הגדרות ביצועים של אפליקציה.
4. מסמנים את התיבה הצגת הכרטיסייה 'ניתוח נתונים של אפליקציות למפתחים'.
5. בוחרים באפשרות Test או Production בשדה Environment to query for analytics data. בפורטל שגלוי לכולם, בדרך כלל בוחרים באפשרות Production.
6. שומרים את ההגדרה.

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

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

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

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

אתם שולטים בתהליך האישור של המפתחות לכל מוצר API כשיוצרים את מוצר ה-API:

תהליך האישור יכול להיות:

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

למידע נוסף, ראו יצירת מוצרים של ממשקי API.

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

כדי לראות את רשימת מוצרי ה-API של אפליקציה ואת סטטוס האישור של המפתח למוצר ה-API, המפתח בוחר את שם האפליקציה בדף 'האפליקציות שלי' ואז לוחץ על הקישור 'מוצרים':

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

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

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

   

5. בוחרים את שם האפליקציה שרוצים לאשר.
6. בדף פרטי האפליקציה, לוחצים על הלחצן עריכה בפינה השמאלית העליונה.
7. ברשימת מוצרי ה-API של האפליקציה, בקטע Actions:
   • כדי לאשר את המפתח, לוחצים על הלחצן Approve לכל מוצר API שדורש אישור ידני.
     

     

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

     

8. שומרים את האפליקציה. מפתח ה-API אושר.

שליטה במטמון של מוצרי API ואפליקציות

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

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

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

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

1. מתחברים לפורטל בתור משתמש עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. בתפריט Drupal, בוחרים באפשרות Configuration > Dev Portal Settings > Application Settings.
3. מסמנים את התיבה Rebuild API Product and Developer App caches every time cron runs (יצירה מחדש של מטמון של אפליקציות למפתחים ומוצרים של API בכל פעם ש-cron פועל) או מבטלים את הסימון שלה.
4. שמור את ההגדרות.

כדי לעדכן את המטמון באופן ידני:

1. מתחברים לפורטל בתור משתמש עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. בתפריט Drupal, בוחרים בסמל הבית > שטיפה של כל המטמון.

התאמה אישית של שדות הטופס המשמשים לרישום אפליקציה

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

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

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

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

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

לדוגמה, כדי להציג את שדות הטופס החדשים בממשק הניהול של Edge, עוברים אל 'פרסום' > 'אפליקציות למפתחים' ובוחרים את שם האפליקציה. ערכי השדות החדשים מופיעים בקטע Custom Attributes (מאפיינים מותאמים אישית) בדף, עם שם שתואם לשם הפנימי של השדה:

ערכי השדות מוצגים גם באזור הפרטים של האפליקציה בדף 'האפליקציות שלי' של המפתח:

המפתח יכול גם לערוך את הערכים על ידי לחיצה על הקישור Edit (עריכה) של האפליקציה בדף My Apps (האפליקציות שלי).

בתהליכים הבאים מוסבר איך להגדיר את הטפסים ליצירת אפליקציות באמצעות ממשק האדמין. מפתחי Drupal יכולים לבצע התאמות אישיות נוספות, כולל שינוי הדף 'האפליקציות שלי', באמצעות ווקים מותאמים אישית. מידע נוסף על שינוי התנהגויות באמצעות קוד זמין בדוגמאות ל-API של האפליקציה בקובץ: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.

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

1. מתחברים לפורטל בתור משתמש עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. מוודאים שהמודול DevConnect App Attribute Management מופעל.
3. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Dev Portal Settings > Dev Portal App Attributes.
4. בחלק העליון של הדף, לוחצים על הלחצן Add Dev Portal App Attribute.
5. מגדירים את השדה. לדוגמה, בשדה Customer ID שמוצג למעלה, צריך להשתמש בהגדרות הבאות:
   • שם פנימי = cust_id. זהו השם של המשתנה שמשמש לשמירת הערך של השדה.
   • שם גלוי לכולם = מספר לקוח
   • Description = מזינים את מספר הלקוח.
   • מסמנים את התיבה שליד 'חובה לציין את המאפיין הזה'.
   • מסמנים את התיבה שלצד 'הצגת המאפיין הזה'.
   • Widget = תיבת טקסט
   • לוחצים על 'שמירה' כדי לחזור לדף 'מאפייני האפליקציה' ב-Dev Portal.
6. בוחרים באפשרות שמירת שינויים.
7. בתפריט Drupal, בוחרים באפשרות סמל הבית > שטיפה של כל המטמון.
   יכול להיות שתצטרכו לנקות את המטמון של הדפדפן כדי שהשדה החדש יופיע בטופס.

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

• Internal Name = intended_platforms
• Public Name = Platforms
• תיאור = מציינים פלטפורמה אחת או יותר לאפליקציה.
• מבטלים את הסימון של התיבות שליד 'חובה לציין את המאפיין הזה'.
• מסמנים את התיבה שלצד 'הצגת המאפיין הזה'.
• Widget = רשימת תיבות סימון
• בוחרים באפשרות 'שמירה' כדי לחזור לדף 'מאפייני האפליקציה' ב-Dev Portal.

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

1. מתחברים לפורטל בתור משתמש עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Dev Portal Settings > Dev Portal App Attributes.
3. בוחרים את סמל הפלוס + מתחת לעמודה Name (שם) וגוררים את הנכס למיקום שבו רוצים להציג אותו בטופס.
4. שומרים את השינויים.