אקטיב טרייל API לא למתקדמים בלבד

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

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

תכנות

דוגמאות קלאסיות לשימוש ב-API:

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

2. שימוש נוסף מיועד בעיקר עבור מערכות BI- Business Intelligence חיצוניות שמבצעות ניתוחים לפי נתונים נוספים שיש להם על הנמענים ולבסוף מייצרים קבוצת נמענים מפולחת לטובת שליחה ספציפית. גם במקרה זה קל ליצור את הקבוצה ישירות בחשבון בעזרת ה-API. אפשר אפילו לקפוץ צעד אחד קדימה ולבצע את כל השליחה בצורה אוטומטית.

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

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

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

ועכשיו לחלק הטכני

להורדת התיעוד המלא:
להורדה

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

ה-API הינו web-services בטכנולוגית SOAP, אשר מכיל 4 שרתים מרכזיים:

  1. User- ניהול קבוצות, רשימות תפוצה (מחיקה, יצירה וכו').
  2. Customer– ניהול נמענים (ייבוא נמענים).
  3. Messaging– ניהול קמפיינים (יצירה ושליחה).
  4. Report– קבלת דוחות.

בתוך כל השרתים האלה יש לכם פונקציות שונות שאתם יכולים לבצע.

אספנו לכם כמה מושגים חשובים שכדאי לכם לדעת אם אתם עובדים דרך ה- API שלנו:

  • Group – קבוצה אשר אליה נרצה לייבא נמענים או לבצע שליחה של קמפיין, לרוב נדרש להעביר את ה-ID של הקבוצה בפונקציות. את ה-ID ניתן לקבל דרך ה-URL בעת כניסה לקבוצה הרלוונטית ב-UI או דרך פונקציה אחרת (userservice/GetGroupIdByName).
  • Mailing list – רשימת תפוצה, פיצ'ר שנמצא בחשבונות ספצייפים. גם כאן נצטרך להעביר ID ובחלק מהמקרים את שם רשימת התפוצה.
  • Customer – לקוח, אובייקט המכיל את כל שדות הלקוח (אימייל, שם פרטי, משפחה וכ'ו). באובייקט זה רק שדה האימייל הוא חובה.
  • Email – אימייל של לקוח, בניגוד לאובייקט 'לקוח' נשתמש באימייל כשלא נרצה להוסיף שדות נוספים ללקוח.
  • Campaign – קמפיין שיווקי אשר נשלח בפעם אחת לקבוצה אחת או יותר, בדרך כלל נשלח לכמויות גדולות.
  • Message – הודעה תפעולית (איפוס סיסמא למשל) או הודעה בודדת שיוצאת ללקוח, בדרך כלל מדובר בשליחה ב'בודדות' לפי תזמונים או מאורעות מיוחדים.
  • Template – תבנית עיצוב קמפיין, ניתן לראות את התבניות ב 'קמפיינים -> התבניות שלי'. ישמש אותנו ליצירה של קמפיין.
  • reportType – סוג הדוח– פתיחות, הקלקות, שגויים וכ'ו.
  • ObjectType – סוג הדיוור– קמפיין / הודעה תפעולית.
  • Classification – מזהה דיוור, ניתן להגדיר אותו בעת שליחת דיוורים דרך ה-API, וכמובן לביצוע חיפוש של דיוורים לטובת קבלת דוחות ספציפים.

אם נחזור רגע לדוגמאות מלמעלה:

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

במקרה זה נשתמש בפונקציה של ייבוא לקוח/אימייל בודד לדוגמא- ImportCustomer כדי להוסיף חדש או לעדכן, נקרא לפונקציה זו בעת שמירת הלקוח במערכת ה-CRM וכן נחסוך ללקוח ייבוא/עדכון ידני.

Import Customer

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

גם כאן נוכל להשתמש בייבוא אבל של כמות לקוחות / אימיילים – ImportCustomers.

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

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

הערות:

  • לכל שרת ישנה פונקצית Login דרכה ניתן לקבל Token הנדרש להפעלת שאר הפונקציות בשרת.
  • פורמט תאריך קבוע הוא: yyyy-mm-dd.
  • ניתן למצוא דוגמאות קוד מלאות בספרית התיעוד שלנו בשפות שונות (.NET PHP ASP).

המדריך נכתב על ידי ג'קי טליאז מצוות התמיכה של אקטיב טרייל

 אתם מוזמנים להיכנס למרכז התמיכה שלנו או לקרוא מאמרים נוספים בבלוג שלנו.