תחילת העבודה עם Application Integration ויעדי שילוב של שרתי proxy של Apigee

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

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

לפני שמתחילים

  • מאשרים את פרטי הכניסה ל-Apigee ואת פרטי הארגון. המידע הזה נדרש כדי לגשת לתכונה Application Integration ולאשף הפרוקסי בממשק המשתמש של Apigee.
  • יוצרים ומפרסמים שילוב עם API Trigger ולפחות משימה אחת.
    • אם עדיין לא יצרתם שילוב שמשתמש בטריגר API, אתם יכולים לפעול לפי השלבים במאמר אחזור מטען ייעודי (payload) של API ושליחת אימייל.
    • חשוב לשים לב לשם השילוב שיוצרים או לשם השילוב הקיים שרוצים להשתמש בו, כי תצטרכו אותו בשלב מאוחר יותר.
  • יוצרים חשבון שירות של Google באותו פרויקט Google Cloud שבו נוצר הארגון שלכם ב-Apigee, ומבצעים את הפעולות הבאות:
    • מקצים לחשבון השירות את התפקיד Application Integration Invoker‏ ((roles/integrations.applicationIntegrationInvokerRole)). מידע על התפקידים המוגדרים מראש של Application Integration זמין במאמר תפקידים מוגדרים מראש ב-IAM.
    • אפשר לתת לחשבון המשתמש (הגורם הראשי) את ההרשאה iam.serviceAccounts.actAs לצרף חשבונות שירות למשאבים. מידע על הרשאות לחשבון שירות זמין במאמר תפקידים לאימות חשבון שירות .

    צריך לספק את חשבון השירות הזה כשפורסים את proxy ל-API.

  • אם רוצים להשתמש בשילובים של אפליקציות ללא הגבלות, אפשר לשלם על השילובים. Application Integration זמין כשירות הרחבה למינוי שלכם. אם כבר רכשתם את הזכאות ל-Application Integration ואתם רוצים להפעיל אותה בפרויקט בענן של Google Cloud או בארגון Apigee, אתם צריכים לפנות לתמיכה של Apigee. עם זאת, אם רוצים לרכוש את זכאות הגישה ל-Application Integration, צריך לפנות למחלקת המכירות של Apigee. אחרי שהפעלנו בשבילכם את Application Integration, צריך לבצע את המשימות הבאות:
    1. מפעילים את ממשקי ה-API הבאים:
      • Apigee API ‏ (apigee.googleapis.com)
      • ‫Application Integration API‏ (integrations.googleapis.com)
      • ‫Secret Manager API ‏ (secretmanager.googleapis.com)
      • Connectors API ‏ (connectors.googleapis.com)

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

    2. מפעילים את השילוב ואת התוספים Connectors בארגון Apigee.

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

        curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" -d '{"name":"${ORG_ID}", "analyticsRegion":"us-west1", "authorized_network":"${NETWORK_ID}", "runtimeType":"CLOUD", "runtimeDatabaseEncryptionKeyName":"${ENCRYPTION_KEY_NAME}", "addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig":{"enabled":true}}}' "https://apigee.googleapis.com/v1/organizations?parent=projects/${PROJECT_ID}"

      • אם אתם משתמשים בארגון קיים, מריצים את הפקודה הבאה:

        curl -H "Authorization: Bearer $TOKEN" -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}:setAddons" -XPOST -d '{"addonsConfig":{"integrationConfig":{"enabled":true},"connectorsPlatformConfig":{"enabled":true}}}'
    3. כדי לוודא שהתוספים הופעלו בהצלחה, משתמשים בפקודה הבאה: 
      curl -H "Authorization: Bearer $TOKEN"  -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}"

      אחרי הרצת הפקודה, אמורה להופיע הודעה דומה לזו:

      {
  "name": "Test....",
  "createdAt": "1615483867669",
  "lastModifiedAt": "1615483873468",
  …...
  "addonsConfig": {
    "integrationConfig": {
      "enabled": true,
    "connectorsPlatformConfig": {
      "enabled": true
    }
  }
  }
    4. מקצים לחשבון השירות שמוגדר כברירת מחדל ב-Apigee(service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com) את תפקידי ה-IAM הבאים:
      • Application Integration Invoker (roles/integrations.applicationIntegrationInvokerRole)

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

יצירת שרת proxy של יעד ל-Application Integration

כדי ליצור שרת proxy של יעד שילוב בממשק המשתמש של Apigee:

‫Apigee במסוף Cloud

  1. במסוף Google Cloud , נכנסים לדף Apigee > Proxy Development > API Proxies.

    מעבר אל API Proxies

  2. בוחרים את הארגון שלכם מתוך בורר הפרויקטים בחלונית Google Cloud.
  3. לוחצים על +יצירה.

  4. ברשימת סוגי ה-proxy, בוחרים באפשרות יעד השילוב.

    מופעל האשף Create a Proxy (יצירת שרת proxy).

  5. בדף ההגדרות Proxy details (פרטי ה-Proxy), מציינים את הפרטים הבאים:
    • שם: מזינים שם לשרת ה-proxy.

      שמות של שרתי proxy יכולים להכיל תווים אלפאנומריים, מקפים וקווים תחתונים.

    • נתיב בסיס: השדה הזה מאוכלס אוטומטית על סמך שם ה-proxy.

      נתיב הבסיס הוא חלק מכתובת ה-URL שמשמשת לשליחת בקשות ל-API. מערכת Apigee משתמשת בכתובת ה-URL כדי להתאים בקשות נכנסות ולנתב אותן ל-proxy ל-API המתאים.

    • תיאור: (אופציונלי) מזינים תיאור קצר של ה-proxy.

      לדוגמה, Proxy test for Application Integration.

    • אזור השילוב: בוחרים את אזור השילוב מהרשימה.
    • יעד השילוב: בוחרים את שם יעד השילוב מהרשימה. שימו לב: הרשימה של יעדי השילוב מאוכלסת על סמך אזור השילוב שנבחר.
    • טריגר: בוחרים מהרשימה את טריגר ה-API שמשויך לשילוב.
    • סוג נקודת הקצה: בוחרים באפשרות סנכרון.
  6. לוחצים על הבא.
  7. (אופציונלי) באזור Deploy:
    • בוחרים סביבת פריסה אחת או יותר.
    • מזינים חשבון שירות.
  8. לוחצים על יצירה.

ממשק משתמש קלאסי

  1. עוברים אל ממשק המשתמש של Apigee ונכנסים לחשבון.
  2. בוחרים את הארגון באמצעות התפריט הנפתח בפינה הימנית העליונה של ממשק המשתמש.
  3. בתצוגה הראשית, לוחצים על API Proxies (פרוקסי ל-API).

    אפשרות נוספת היא לבחור באפשרות פיתוח > שרתי proxy של API בתפריט הניווט הימני.

  4. מהרשימה הנפתחת סביבה, בוחרים את הסביבה שבה רוצים ליצור proxy ל-API חדש.
  5. לוחצים על חדש.
  6. ברשימת סוגי ה-proxy, בוחרים באפשרות יעד השילוב.

    האשף ליצירת שרת proxy מתחיל.

  7. בדף ההגדרות Proxy details (פרטי ה-Proxy), מציינים את הפרטים הבאים:
    • שם: מזינים שם לשרת ה-proxy.

      שמות של שרתי proxy יכולים להכיל תווים אלפאנומריים, מקפים וקווים תחתונים.

    • נתיב בסיס: השדה הזה מאוכלס אוטומטית על סמך שם ה-proxy.

      נתיב הבסיס הוא חלק מכתובת ה-URL שמשמשת לשליחת בקשות ל-API. מערכת Apigee משתמשת בכתובת ה-URL כדי להתאים בקשות נכנסות ולנתב אותן ל-proxy ל-API המתאים.

    • תיאור: (אופציונלי) מזינים תיאור קצר של ה-proxy.

      לדוגמה, Proxy test for Application Integration.

    • אזור השילוב: בוחרים את אזור השילוב מהרשימה הנפתחת.
    • יעד השילוב: בוחרים את שם יעד השילוב מהתפריט הנפתח. שימו לב: הרשימה של יעדי השילוב מאוכלסת על סמך אזור השילוב שנבחר.
    • טריגר: בוחרים את טריגר ה-API שמשויך לשילוב מהרשימה הנפתחת.
    • סוג נקודת הקצה: בוחרים באפשרות סנכרון.
  8. לוחצים על הבא.
  9. בדף ההגדרות Common policies, משאירים את ברירות המחדל ולוחצים על Next.
  10. בדף סיכום, לוחצים על יצירה.

    נוצר בהצלחה פרוקסי של יעד שילוב.

פריסת שרת ה-proxy

כדי לפרוס את ה-proxy החדש שנוצר:

‫Apigee במסוף Cloud

  1. במסוף Google Cloud , נכנסים לדף Apigee > Proxy Development > API Proxies.

    מעבר אל API Proxies

  2. לוחצים על ה-proxy שנוצר לאחרונה שרוצים לפרוס. בממשק מוצגת כברירת מחדל הכרטיסייה סקירה כללית.
  3. לוחצים על פריסה.
  4. ממלאים את הפרטים הבאים:
    • Revision (גרסה): מספר הגרסה של ה-proxy שרוצים לפרוס.
    • סביבה: הסביבה שבה רוצים לפרוס את ה-proxy.
    • חשבון שירות: חשבון השירות שנוצר עבור ה-proxy.
  5. לוחצים על פריסה.

ממשק משתמש קלאסי

  1. בממשק המשתמש של Apigee, בוחרים באפשרות Develop > API Proxies (פיתוח > שרתי proxy של API).

    בממשק המשתמש מוצגת רשימה של שרתי proxy של API וסטטוס הפריסה שלהם.

  2. בתפריט הנפתח Environment, בוחרים את הסביבה שבה רוצים לפרוס את ה-proxy ל-API.

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

  4. כדי לפרוס את השינויים, קודם לוחצים על פריסה כדי להציג את תיבת הדו-שיח פריסה.
  5. מזינים את הפרטים הבאים:
    • Revision (גרסה): מספר הגרסה של ה-proxy שרוצים לפרוס.
    • סביבה: הסביבה שבה רוצים לפרוס את ה-proxy.
    • חשבון שירות: חשבון השירות שנוצר עבור ה-proxy.
  6. לוחצים על פריסה.

ממשק המשתמש מתחיל בתהליך הפריסה של הגרסה שנבחרה. פריסת ה-proxy עשויה להימשך עד דקה.

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

בדיקת שרת ה-proxy של יעד האינטגרציה

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

curl -v https://YOUR_ENV_GROUP_HOSTNAME/PROXY_NAME

כאשר YOUR_ENV_GROUP_HOSTNAME הוא שם המארח של קבוצת סביבות שמכילה את הסביבה שבה ה-proxy שלכם נפרס.

לדוגמה: 

curl -v https://my-org-prod.hybrid.e2e.apigeeks.net/my-proxy

כדי לוודא שהשילוב הופעל על ידי הפעלת ה-proxy:

‫Apigee במסוף Cloud

  1. נכנסים לדף Application Integration במסוף Google Cloud .

    מעבר אל Application Integration

  2. בתפריט הניווט, לוחצים על Logs (יומנים). יופיע הדף Execution Logs (יומני ביצוע), שבו מפורטים יומני הביצוע שנוצרו לשילובים באזור ברירת המחדל.
  3. מוודאים שקיים יומן ביצוע לשילוב שהופעל.
  4. כדי לראות את פרטי היומן, לוחצים על החץ להרחבה כדי להרחיב את פרטי השילוב.
    • כדי לראות את פרטי ההפעלה של משימה ספציפית, לוחצים על מזהה המשימה. מוצגת החלונית Task Execution Details (פרטי הרצת המשימה) עם פרטי ההרצה של המשימה. פרטי ביצוע המשימה פרטי ביצוע המשימה
    • כדי לראות את פרמטרים הבקשה והתגובה של המשימה, לוחצים על Request Parameters או על Response Parameters.

      פרמטרים של בקשות ביומני הביצוע פרמטרים של בקשות ביומני הביצוע

    • כדי לראות את יומני ההפעלה של שילוב משני, מרחיבים את מזהה המשימה ולוחצים על השם של השילוב המשני. ההגדרה הזו חלה על משימת שילוב שיחות, משימת For Each Parallel, משימת For Each Loop ומשימת While Loop.

ממשק משתמש קלאסי

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

עדכון מטען הייעודי (payload) של בקשת ה-proxy (אופציונלי)

כדי לעדכן את מטען הייעודי (payload) של בקשת ה-proxy:

‫Apigee במסוף Cloud

  1. במסוף Google Cloud , עוברים לדף Proxy Development > API Proxies.

    מעבר אל API Proxies

  2. לוחצים על ה-proxy שנוצר לאחרונה שרוצים לעדכן.

    כברירת מחדל, בכלי לעריכת שרת proxy מוצגת הכרטיסייה סקירה כללית של אותו שרת proxy.

  3. לוחצים על הכרטיסייה פיתוח.
  4. בחלונית Navigator, בקטע Policies, בוחרים באפשרות Set Integration Request.

  5. מבטלים את ההערה של הבלוק <Parameters> ומזינים את פרטי הפרמטרים.

    כדי לציין פרמטרים נפרדים, משתמשים ברכיב <Parameter>. כדי לציין מערכי פרמטרים, משתמשים ברכיב <ParameterArray>.

  6. לוחצים על Save.

ממשק משתמש קלאסי

  1. בממשק המשתמש של Apigee, בוחרים באפשרות Develop > API Proxies (פיתוח > שרתי proxy של API) בתפריט הניווט הימני.
  2. לוחצים על ה-proxy שיצרתם לאחרונה.

    כברירת מחדל, בכלי לעריכת שרת proxy מוצגת הכרטיסייה סקירה כללית של אותו שרת proxy.

  3. לוחצים על הכרטיסייה פיתוח.
  4. בחלונית Navigator, בוחרים באפשרות Set Integration Request (הגדרת בקשת שילוב) בקטע Policies (מדיניות).
  5. מבטלים את ההערה של הבלוק <Parameters> ומזינים את פרטי הפרמטרים.

    כדי לציין פרמטרים נפרדים, משתמשים ברכיב <Parameter>. כדי לציין מערכי פרמטרים, משתמשים ברכיב <ParameterArray>.

  6. לוחצים על Save.

המאמרים הבאים

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