חיבור תהליך משותף באמצעות קרס לזרימה

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

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

מכיוון שקוד שמצורף ל-hook לזרימה נמצא מחוץ להקשר של לוגיקת הליבה של שרת ה-API של שרת ה-API, חלק מההתנהגות שלו שונה משרתי ה-proxy של ה-API. חשוב לזכור:

  • צריכה להיות לכם הרשאה לצרף תהליך משותף ל-hook של זרימה. עליכם להיות מנהלי מערכת בארגון.
  • לכל הוק של זרימה אפשר לצרף רק תהליך משותף אחד.
  • אפשר לצרף את אותה תהליך עבודה משותף לכמה פריטי hook.
  • אם תהליך השיתוף שצורף אל ה-hook של הזרימה יוצר תקלה או שיש שגיאות במהלך הביצוע של תהליך השיתוף, ההודעה תידחה והשגיאה תוחזר למתקשר.
  • אם הודעה נדחית במהלך ביצוע webhook, הפרטים יתועדו ב-Analytics בהקשר של שרת ה-proxy שנקרא. התהליך המשותף עשוי גם לגרום לתקלה עם קוד מותאם אישית והודעת שגיאה

בסרטון הבא מוסבר איך לחבר תהליך משותף ל-hook של זרימה, ולאחר מכן לעקוב אחריו, בממשק המשתמש הקלאסי של Edge.

בסרטון הבא מוסבר איך לחבר תהליך משותף ל-hook של זרימה, ולאחר מכן לעקוב אחריו, בממשק המשתמש של New Edge.

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

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

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

מחברים תהליך משותף ל-hook של זרימה באמצעות מסוף הניהול של Apigee Edge. אפשר לצרף לכל היותר תהליך משותף אחד אל הוק זרימה בכל אחד מהמקומות הבאים:

  • הכנת מסלול זרימה לפני שרת ה-proxy ללוגיקה שצריך לאכוף אותה לפני ההפעלה של נקודת קצה (endpoint) של שרת proxy.

    לדוגמה, יכולה להיות לכם לוגיקה לאכיפת אבטחה בכל ממשקי ה-API בסביבה מסוימת.

  • הוק זרימה של היעד מראש ללוגיקה שיש לאכוף לפני הפעלת היעד.

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

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

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

  • דוח זרימה אחרי שרת proxy ללוגיקה שצריך לאכוף אותה אחרי נקודת הקצה של שרת ה-proxy וממש לפני שליחת התגובה ללקוח.

    הפעולות האלה יכולות לכלול לוגיקת אכיפה כלשהי של CORS, רישום התגובה או ביצוע מאש-אפ או עיצוב.

חיבור של תהליך משותף ל-hook של זרימה

כדי לצרף תהליך משותף ל-hook של זרימה, עליך להיות אדמין בארגון שכולל את התהליך המשותף.

  1. גש לדף 'הוקי זרימה' כפי שמתואר בהמשך.

    Edge

    כדי לגשת לדףflow Hooks באמצעות ממשק המשתמש של Edge:

    1. נכנסים לאתר apigee.com/edge.
    2. בוחרים את הארגון שכולל את התהליך המשותף. למידע נוסף, ראו מעבר בין הארגונים.

      התהליך המשותף יהיה זמין לכל שרת proxy של API ותהליכי עבודה משותפים שנפרסו בסביבה מהארגון הזה. התוכן לא יהיה זמין מחוץ לארגון הזה.

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

    Classic Edge (ענן פרטי)

    כדי לגשת לדףflow Hooks באמצעות ממשק המשתמש הקלאסי Edge:

    1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
    2. בוחרים את הארגון שכולל את התהליך המשותף. למידע נוסף, ראו מעבר בין הארגונים.

      התהליך המשותף יהיה זמין לכל שרת proxy של API ותהליכי עבודה משותפים שנפרסו בסביבה מהארגון הזה. התוכן לא יהיה זמין מחוץ לארגון הזה.

    3. בסרגל הניווט העליון, בוחרים באפשרות APIs > Environment Configuration (הגדרת סביבה) >flow Hooks.
  2. ברשימת קטעי ה-hook של הזרימה, מזהים את ה-hook של הזרימה שאליו ברצונך לצרף את התהליך המשותף, על סמך המקום שבו ברצונך שהתהליך המשותף יתבצע.
    מיקום קרס זרימה התיאור
    קרס זרימה לפני שרת proxy לפני שנקודת קצה (endpoint) של שרת proxy מופעלת
    קרס זרימה לפני היעד לפני שנקודת קצה (endpoint) של יעד מבוצעת
    קרס זרימה אחרי היעד לאחר הביצוע של תגובת היעד
    קרס זרימה אחרי שרת proxy אחרי נקודת הקצה של שרת ה-proxy וממש לפני שליחת התשובה ללקוח
  3. מציבים את הסמן מעל לווסת הזרימה ברשימה כדי להציג את עמודת הפעולות.
  4. לוחצים על .
  5. בתיבת הדו-שיח 'תהליך עבודה משותף', בתפריט הנפתח תהליך עבודה משותף, בוחרים בתהליך המשותף שרוצים לצרף.
  6. לוחצים על אישור.
  7. ניתן לצרף תהליכי עבודה משותפים לקטעי זרימה אחרים, לפי הצורך.