קליטת פניות ב-API ממערכת חיצונית כולל שם הערוץ במערכת FIX Marketing של פיקס דיגיטל

Table of Contents

חלק א: חיבור ה-API
חלק ב: שם הערוץ וערוץ ייעודי

רוצים שכל פנייה ממערכת חיצונית תיכנס אוטומטית אל FIX Marketing, עם שם הערוץ שממנו הגיעה? במדריך הזה נראה איך מחברים מערכת חיצונית באמצעות API, ואיך כל פנייה נכנסת עם שם הערוץ שלה.

חלק א: חיבור ה-API

1. איך זה עובד

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

איך זה עובד

2. נכסים דיגיטליים

כדי להתחיל, יש ללחוץ על "נכסים דיגיטליים" בתפריט העליון.

נכסים דיגיטליים

3. לשונית חיבורי API

במסך "נכסים דיגיטליים", יש לעבור ללשונית "חיבורי API".

לשונית חיבורי API

4. חיבור API חדש

ואז ללחוץ על "חיבור API חדש".

חיבור API חדש

5. הגדרה עצמית או מתכנת

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

הגדרה עצמית או מתכנת

6. שם החיבור

בשדה "שם החיבור", יש לרשום שם ברור למקור ההגעה הזה, כדי לזהות אותו בקלות בהמשך.

שם החיבור

7. ללא מיזוג הזמנות

כשהמתג "ללא מיזוג הזמנות" פעיל, כל הזמנה נכנסת כעסקה נפרדת.

ללא מיזוג הזמנות

8. לשלב הבא

ואז יש ללחוץ על "לשלב הבא".

לשלב הבא

9. הגדרת חיבור API

בלשונית "מיפוי", בשלב "סוג חיבור טכנולוגי", יש לבחור "הגדרת חיבור API".

הגדרת חיבור API

10. הוסף קוד

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

הוסף קוד

11. הטמעה בתגית HEAD

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

הטמעה בתגית HEAD

12. מתי מדלגים על הקוד

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

מתי מדלגים על הקוד

13. כתובת החיבור

בשלב "אינטגרציה" מופיעה כתובת החיבור. המערכת החיצונית שולחת אליה כל פנייה חדשה, בבקשת POST. אפשר להעתיק את הכתובת בלחיצה על "העתקת קוד".

כתובת החיבור

14. פרמטרים לפנייה

מתחת לכתובת מפורטים הפרמטרים לפנייה, למשל פרטי הקשר: שם, אימייל וטלפון.

פרמטרים לפנייה

15. מספר הערוץ מהקוקיז

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

מספר הערוץ מהקוקיז

16. שדות נוספים

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

שדות נוספים

17. פרמטרים להזמנות

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

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

18. פניות בלי הקמפיין הנכון

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

פניות בלי הקמפיין הנכון

19. פניית בדיקה

בשלב האחרון, יש לשלוח פניית בדיקה מהמערכת החיצונית, וללחוץ על "רענון". הפנייה מופיעה בטבלה.

פניית בדיקה

20. סיום ההגדרה

ואז ללחוץ על "סיום".

סיום ההגדרה

21. חיבור CRM

בלשונית "CRM" אפשר לקבוע לאיזה תהליך, סטטוס ונציג ייכנסו אוטומטית הפניות ממקור הגעה זה.

חיבור CRM

22. שמירת החיבור

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

שמירת החיבור

23. שליחה למתכנת

בחלון "יצירת חיבור API", אם המתכנת שלכם מגדיר את החיבור, יש לבחור באפשרות הזו, לרשום את כתובת האימייל שלו, וללחוץ על "שליחת הודעה".

שליחה למתכנת

24. קישור ישיר למתכנת

לחיבור קיים, אפשר לשלוח למתכנת קישור ישיר להגדרת החיבור, בלשונית "מיפוי". יש להפעיל את המתג "לאפשר גישה דרך הקישור", וללחוץ על "העתקת קישור". הקישור נכבה אוטומטית אחרי 30 יום.

קישור ישיר למתכנת

25. חזרה להגדרות החיבור

כדי לחזור להגדרות החיבור בהמשך, במסך "חיבורי API", יש ללחוץ על שלוש הנקודות בשורה של החיבור, ולבחור "הגדרות חיבור".

חזרה להגדרות החיבור

חלק ב: שם הערוץ וערוץ ייעודי

26. שם הערוץ: שתי דרכים

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

שם הערוץ: שתי דרכים