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

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

פורטל השירותים למפתחים פועל כלקוח של 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 ו-TLSport היא יציאת ה-TLS/SSL של ממשק ה-Edge Management API. לדוגמה, 8443.
  • שם הארגון ב-Apigee

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

    הקריאות מהפורטל אל Edge מאומתות ומחייבות משתמש עם הרשאות אדמין למפתחים. כשיוקצה לכם פורטל למפתחים, התפקיד 'אדמין של מפתח' יתווסף לארגון שלכם. התפקיד הזה, שכולל משתמש יחיד בשם devadmin+{org_name}@apigee.com, מיועד אך ורק לחיבור הפורטל למפתחים לארגון שלך ב-Edge. מכיוון שבפורטל מוצגים אפליקציות למפתחים של Edge, מוצרי API וכו', הוא צריך להישאר מסונכרן עם הארגון ב-Edge על ידי ביצוע קריאות ל-API לניהול שדורשות אימות. ל "משתמש" של ה-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. מזינים את פרטי הכניסה של אדמין הארגון בשדות Endpoint Authenticated User ו-Authenticated User's password.
  5. בוחרים באפשרות בדיקת החיבור כדי לוודא שהחיבור מתבצע בהצלחה.
  6. בוחרים באפשרות Save Configuration (שמירת התצורה).

הבטחת גישה ל-Edge מהפורטל

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

כשמפתח מתחבר לפורטל, הפורטל הוא האחראי לאימות המפתח ולאכיפה של הרשאות הגישה לפי תפקיד.

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

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

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

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

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

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

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