עיבוד מקדים של תוכן האירוע לכל יעד

בשביל מה זה טוב

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

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

שש הפעולות

איך מגדירים

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

curl -X PATCH https://api.hookget.com/v1/endpoints/ep_…   -H "authorization: Bearer $HOOKGET_KEY"   -d '{"transformation":[{"omit":["data.card"]},{"set":{"via":"hookget"}}]}'

התאמה למקבל עם פורמט קבוע

כשהמקבל רוצה גוף משלו ולא את המעטפת שלנו, משלבים unwrap, pick ו-set:

[
  {"unwrap": "data"},
  {"pick": ["order.id", "order.total"]},
  {"set": {"source": "hookget"}}
]

התוצאה שנמסרת היא {"order":{"id":…,"total":…},"source":"hookget"}, והחתימה מחושבת בדיוק על הבתים האלה. לכן אימות החתימה בצד המקבל עובד בלי שום שינוי: הוא מאמת את מה שהגיע אליו, לא את מה שפורסם במקור.

הכללים ששומרים על העיבוד בטוח