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

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

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

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

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

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

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

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

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

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

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

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

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

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

ציון רמת הגישה כשיוצרים מוצר API

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

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

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

כשמפעילים את המודול Product Role Access Drupal ב-API, אפשר לציין את התפקידים שיכולים לגשת לכל מוצר ב-API.

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

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בודקים את התפקידים בפורטל הפיתוח ואת הקצאות המשתמשים:
   • בתפריט הניהול של Drupal בוחרים באפשרות אנשים > הרשאות > תפקידים בתפריט הניהול של Drupal, ומוסיפים או עורכים את התפקידים וההרשאות למפתחים, לפי הצורך.
   • בוחרים באפשרות אנשים בתפריט הניהול של Drupal ועורכים את ההקצאות של המשתמשים והתפקידים, לפי הצורך.
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.
4. בקטע API Product Treatment (טיפול במוצרים API), בוחרים את האפשרות שקובעת את אופן בחירת המוצרים של ה-API.
5. אם בוחרים באפשרות 'שיוך כל האפליקציות למוצר אחד או יותר של ברירת המחדל של ה-API (מוגדר למטה)', מגדירים מוצר ברירת מחדל בקטע מוצר ברירת המחדל של API.
6. בקטע ווידג'ט מוצר של API, בוחרים את רכיב ה-HTML שבו משתמשים המפתחים כדי לבחור את מוצרי ה-API.
7. שומרים את התצורה.

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

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

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

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

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

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

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Dev Portal > Application Settings.
3. בדף 'הגדרות האפליקציה', מרחיבים את הקטע App Performance settings (הגדרות של ביצועי אפליקציות).
4. מסמנים את התיבה הצגת הכרטיסייה 'ניתוח נתונים של אפליקציות למפתחים'.
5. בוחרים באפשרות בדיקה או באפשרות ייצור בשדה סביבה כדי להריץ שאילתות על נתוני ניתוח. בפורטל שזמין לציבור, בדרך כלל בוחרים באפשרות Production.
6. שומרים את התצורה.

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

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

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

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

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

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

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

מידע נוסף זמין במאמר יצירת מוצרי API.

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

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

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

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

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

   

5. בוחרים את שם האפליקציה שרוצים לאשר.
6. בדף הפרטים של האפליקציה, לוחצים על הלחצן עריכה בפינה השמאלית העליונה.
7. ברשימת מוצרי ה-API של האפליקציה, בקטע פעולות:
   • כדי לאשר את המפתח, לוחצים על הלחצן 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. מסמנים את התיבה בנייה מחדש של מטמון המוצרים ואפליקציות למפתחים בכל פעם ש-cron פועל.
4. שמור את ההגדרות.

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

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

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

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

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

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

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

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

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

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

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

הנהלים בהמשך מתארים כיצד להגדיר את טופסי היצירה של אפליקציה באמצעות ממשק הניהול. מפתח של Drupal יכול לבצע התאמות אישיות נוספות, כולל שינוי הדף 'האפליקציות שלי' באמצעות קטעי hook בהתאמה אישית. למידע נוסף על שינוי התנהגויות באמצעות קוד, ניתן לעיין בדוגמאות של ה-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. מגדירים את השדה. לדוגמה, בשדה 'מספר לקוח' שמוצג למעלה, משתמשים בהגדרות הבאות:
   • שם פנימי = cust_id. זהו שם המשתנה שמשמש לאחסון ערך השדה.
   • שם ציבורי = מספר לקוח
   • תיאור = מזינים את מספר הלקוח.
   • מסמנים את תיבת הסימון 'נדרש המאפיין הזה'
   • מסמנים את תיבת הסימון 'הצגת המאפיין הזה'.
   • Widget = תיבת טקסט
   • יש לבחור באפשרות 'שמירה' כדי לחזור לדף 'מאפייני האפליקציה בפורטל הפיתוח'.
6. בוחרים באפשרות שמירת השינויים.
7. בתפריט Drupal, בוחרים בסמל הבית > ניקוי כל המטמון.
   יכול להיות שתצטרכו לנקות את המטמון של הדפדפן כדי שהשדה החדש יופיע בטופס.

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

• Internal Name = intent_platforms
• שם ציבורי = פלטפורמות
• תיאור = יש לציין פלטפורמה אחת או יותר לאפליקציה.
• מבטלים את הסימון של התיבות 'חובה את המאפיין הזה'
• מסמנים את התיבה 'הצגת המאפיין הזה'.
• ווידג'ט = רשימת תיבות סימון
• יש לבחור באפשרות 'שמירה' כדי לחזור לדף 'מאפייני האפליקציה בפורטל הפיתוח'.

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

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