התקשורת בין פורטל המבוסס על Drupal לבין Edge

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

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

Edge לא שולח בקשות לפורטל, אלא רק מגיב לבקשות שנשלחות מהפורטל. לכן, כל האינטראקציות בין הפורטל לבין Edge מתחילות בפורטל.

הגדרת החיבור בין הפורטל ל-Edge

יש שלושה פרטים שהפורטל צריך להעביר ל-Edge, כפי שמפורט בהמשך.

• כתובת ה-URL של נקודת הקצה של Edge
  
  כתובת ברירת המחדל של נקודת הקצה בגרסה מבוססת-הענן של Edge היא https://api.enterprise.apigee.com/v1.
  
  בהטמעה בענן פרטי, כתובת ה-URL היא בפורמט: http://EdgePrivateCloudIp:8080/v1 או https://EdgePrivateCloudIp:TLSport/v1.
  
  כאשר EdgePrivateCloudIp היא כתובת ה-IP של שרת Edge Management Server ו-TLSport הוא יציאת ה-TLS/SSL ל-Edge management API. לדוגמה, 8443.
• שם הארגון ב-Apigee
  
  זהו שם הארגון שלכם ב-Edge. מגדירים את הארגון כשיוצרים את החשבון ב-Edge.
• שם משתמש וסיסמה של אדמין למפתחים
  
  הקריאות מהפורטל ל-Edge עוברות אימות, ונדרש משתמש עם הרשאות אדמין למפתחים. כשמגדירים לכם פורטל למפתחים, התפקיד 'אדמין למפתחים' מתווסף לארגון שלכם. התפקיד הזה, שכולל משתמש יחיד בשם devadmin+{org_name}@apigee.com, מיועד אך ורק לחיבור של Developer Portal לארגון Edge. מכיוון שבפורטל מוצגים אפליקציות הפיתוח שלכם ב-Edge, מוצרי ה-API וכו', הוא צריך להיות מסונכרן עם הארגון שלכם ב-Edge באמצעות קריאות ל-Management API שדורשות אימות. למשתמש 'user' עם הרשאת devadmin יש את ההרשאות הנדרשות.
  

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

1. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Dev Portal > Application Settings.

כדי לשנות את ההגדרות:

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

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

1. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Dev Portal Settings.
2. מזינים את שם הארגון בקטע Management API Organization.
3. מזינים את כתובת ה-URL של נקודת הקצה של Edge בשדה כתובת ה-URL של נקודת הקצה של Management API.
4. מזינים את פרטי הכניסה של האדמין הארגוני בשדות משתמש מאומת בנקודת קצה וסיסמה של משתמש מאומת.
5. בוחרים באפשרות בדיקת החיבור כדי לוודא שהחיבור בוצע בהצלחה.
6. בוחרים באפשרות Save Configuration.

איך מוודאים שיש גישה ל-Edge מהפורטל

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

אפשר לפרוס את Edge ואת הפורטל גם בענן וגם בארגון, ואפשר לשלב בין סוגי הפריסות. לדוגמה, אפשר לפרוס את שניהם בענן, שניהם בארגון או אחד בענן ואחד בארגון:

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

ניהול אפליקציות ומפתחות API מהפורטל

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

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

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

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

אם המפתח מוסיף, מסיר או משנה אפליקציה, השינויים האלה נשלחים מהפורטל אל Edge.

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

• הוספה, הסרה או שינוי של אפליקציה של מפתח
• ביטול או אישור של מפתח API לאפליקציה

בהמשך מוצגת אותה אפליקציה, 'אפליקציית מזג האוויר שלי', כפי שהיא נראית לאדמין בממשק המשתמש של Edge:

ניהול מפתחים דרך הפורטל

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

פרטי המפתחים ששמורים ב-Edge כוללים:

• שם פרטי
• שם משפחה
• כתובת אימייל
• מידע נוסף אופציונלי שנשלח מהפורטל

בפורטל מאוחסן אותו מידע כמו ב-Edge, אבל גם מידע נוסף, כולל:

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

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

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

מידע נוסף זמין במאמר הוספה וניהול של חשבונות משתמשים.

סנכרון של מפתחי אפליקציות בין הפורטל לבין Edge

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

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

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

:

• מתחברים לפורטל בתור משתמש עם הרשאות אדמין או הרשאות ליצירת תוכן.
• בתפריט הניהול של Drupal, בוחרים באפשרות אנשים.
• לוחצים על הלחצן Dev Portal Developer Sync בחלק העליון של הדף כדי לסנכרן עם מפתחי האפליקציות ב-Edge.