Account Web Service

‫שימוש ב‪ Web Service‬להתממשקות למערכת פולסים‬
‫שירותי ‪ Web Services‬מאפשרים לאפליקציות להתקשר ולשתף מידע דרך האינטרנט‪ ,‬ללא‬
‫התחשבות בסוג מערכת ההפעלה‪ ,‬ההתקן או שפת התכנות‪ .‬המידע מועבר על ידי שימוש ב ‪.XML -‬‬
‫באמצעות השימוש ב‪ ,Web Services‬פולסים מאפשרת לכם להוסיף דואר אלקטרוני ופרטי לקוח‬
‫אחרים מהמערכת שלכם (בדרך כלל זה האתר שלכם) למערכת פולסים‪.‬‬
‫הערה‪ :‬במידה ואתם מוסיפים דואר אלקטרוני שכבר קיים במערכת באמצעות ה ‪ Web Service‬הדואר‬
‫האלקטרוני החדש שכבר הוסף יעודכן בפרטים החדשים שנשלחו‪.‬‬
‫פולסים ‪ Web Service‬יושב בכתובת‪:‬‬
‫‪http://www.pulseem.co.il/Pulseem/pulseemservices.asmx‬‬
‫לחיצה על לינק זה יציג לכם את הפונקציות הקימות ב ‪ Web Service‬של מערכת פולסים‪.‬‬
‫פונקציות קיימות‪:‬‬
‫‪‬‬
‫‪‬‬
‫‪‬‬
‫‪‬‬
‫‪‬‬
‫‪‬‬
‫‪‬‬
‫‪‬‬
‫‪‬‬
‫‪AddCampaign‬‬
‫‪AddGroup‬‬
‫‪SendCampaign‬‬
‫‪AddNewClient‬‬
‫‪AddNewClientByEmail‬‬
‫‪AddNewClientExtended‬‬
‫‪RemoveClientsFromGroups‬‬
‫‪GetUnsubscribeEmailClients‬‬
‫‪UnsubscribeEmailClients‬‬
‫פרמטרים לפונקציות‪:‬‬
‫‪-AddCampaign‬‬
‫תיאור‪ :‬מאפשר להוסיף קמפיין חדש‪.‬‬
‫פרמטרים של הפונקציה‪:‬‬
‫)‪ -Password(string‬סיסמה לשימוש ב‪ .web service‬אתם תקבלו סיסמה יחודית לשימוש ב ‪Web‬‬
‫‪Service‬‬
‫)‪ -Name (string‬שם הקמפיין לתיעוד‬
‫)‪ -Subject (string‬נושא המייל‬
‫)‪ -HTML(string‬קוד ה‪ HTML‬שהוא למעשה יכיל את תוכן המייל‬
‫)‪ -fromEmail(string‬כתובת דואר האלקטרוני של השולח (חשוב לדייק)‬
‫פולסים דיוור אלקטרוני‬
‫מורשה | שדרות מסריק ‪ 31‬תל אביב טל ‪ 31-0423423‬פקס ‪ 31-0420243‬כל הזכויות שמורות‪.‬‬
‫)‪ -fromName (string‬שם השולח של המייל‬
‫)‪ -printLinkPosition(int‬הוספת טקסט אוטומטי לקמפיין‪"-‬להדפסת דף זה לחץ כאן" ‪ -3‬ללא תוספת‬
‫זאת ‪ -3‬הוספה בראשית המייל ‪ -4‬הוספה בתחתית המייל‬
‫)‪ -clickHereToSeeLinkPosition(int‬הוספת לינק אוטומטי להצגת בקמפיין‪"-‬אם אינך רואה מייל זה‬
‫הקלק כאן" ‪ – 3‬ללא תוספת זאת ‪ -3‬הוספת בראשית המייל ‪ -4‬הוספה בתחתית המייל‬
‫)‪ -removeClickLinkPosition(int‬הוספת לינק הסרה מהרשימה (לפי חוק חובה) לכן רק יתאפשר‬
‫לשנות מיקום‪ -3 -‬הוספה בראשית המייל ‪ -4‬הוספה בתחתית המייל‬
‫)‪ -LanguageCode(int‬שפת הקידוד של ה‪(HTML‬כולל שפת התוספות כגון ההסרה‪ ,‬הדפסה וכו')‪:‬‬
‫‪3‬‬
‫‪3‬‬
‫עברית‬
‫‪2‬‬
‫הונגרית‬
‫אנגלית‬
‫‪4‬‬
‫צרפתית‬
‫‪1‬‬
‫ספרדית‬
‫‪2‬‬
‫גרמניה‬
‫‪0‬‬
‫רוסית‬
‫‪6‬‬
‫יפנית‬
‫‪7‬‬
‫רומנית‬
‫‪8‬‬
‫ערבית‬
‫פרמטר חוזר (‪-)string‬מחזיר את קוד הקבוצה שנוצרה‪ .‬כל הודעה אחרת הינה שגיאה או הודעת‬
‫טעות‪.‬‬
‫‪-AddGroup‬‬
‫תיאור‪ :‬מאפשר להוסיף קבוצה חדשה‪.‬‬
‫פרמטרים של הפונקציה‪:‬‬
‫)‪ -Password(string‬סיסמה לשימוש ב‪ .web service‬אתם תקבלו סיסמה יחודית לשימוש ב ‪Web‬‬
‫‪Service‬‬
‫)‪ -Name (string‬שם הקבוצה‪.‬‬
‫)‪ -isTestGroup(Boolean‬האם לסמן את הקבוצה כקבוצת ניסיון‪.‬‬
‫פרמטר חוזר (‪ -)int‬קוד הקבוצה שנוספה‪.‬‬
‫‪-SendCampaign‬‬
‫תיאור‪ :‬מאפשר לשלוח קמפיין למספר קבוצות‪.‬‬
‫פרמטרים של הפונקציה‪:‬‬
‫)‪ -Password(string‬סיסמה לשימוש ב‪ .web service‬אתם תקבלו סיסמה יחודית לשימוש ב ‪Web‬‬
‫‪Service‬‬
‫)][‪ -GroupID(int‬מערך המכיל את קודי הקבוצות אליהן ישלח הקמפיין (ניתן לשלוח כמה קבוצות)‬
‫)‪ -CampaignID(int‬קוד הקמפיין אליו ישלחו הקבוצות‪.‬‬
‫פולסים דיוור אלקטרוני‬
‫מורשה | שדרות מסריק ‪ 31‬תל אביב טל ‪ 31-0423423‬פקס ‪ 31-0420243‬כל הזכויות שמורות‪.‬‬
‫פרמטר חוזר (‪ "Success" -)string‬מודיע על הצלחה‪ -‬כל הודעה אחרת הינה שגיאה או הודעת טעות‪.‬‬
‫‪-AddNewClient‬‬
‫תיאור‪ :‬מאפשרת להוסיף מייל למערכת הכוללת את כל פרטי הלקוח הסטנדרטים‪.‬‬
‫פרמטרים של הפונקציה‪:‬‬
‫)‪ -Password(string‬סיסמא לשימוש ב‪ .web service‬אתם תקבלו סיסמה יחודית לשימוש ב ‪Web‬‬
‫‪Service‬‬
‫)‪ -GroupID(interger‬מספר הקבוצה במערכת פולסים שאתם רוצים להוסיף אליה את הרשימה‬
‫)‪ -Email(string‬כתובת המייל‬
‫)‪ -First Name(string‬שם פרטי‬
‫)‪ -Last Name(string‬שם משפחה‬
‫)‪ -Birthday(date‬תאריך לידה‬
‫)‪ -City(string‬עיר‬
‫)‪ -Address(string‬כתובת‬
‫)‪ -Zip(string‬מיקוד‬
‫)‪ -Country(string‬ארץ‬
‫)‪ -State)String‬מדינה‬
‫)‪ -Company(string‬חברה‬
‫)‪-Telephone(string‬טלפון‬
‫)‪ - Cellphone )String‬טלפון סלולרי (מבנה הינו‪ XXX-XXXXXXX :‬או ‪ XXXXXXXXXX‬בלבד!‪ -‬כל מבנה‬
‫אחר ידחה)‬
‫)‪ -needOptin(Boolean‬האם הלקוח צריך לאשר את המייל בשביל להפעילו (‪ .)DOUBLE OPTIN‬אם‬
‫אינכם משתמשים ביכולת זו פשוט רשמו ‪false‬‬
‫)‪ -toOverWrite(Boolean‬במידה והמייל כבר קיים האם לדרוס את הנתונים הקיימים שלו‪ .‬במידה‬
‫ומוגדר כ‪ FALSE‬והמייל כבר קיים המערכת תתעלם ולא תשנה נתונים‪.‬‬
‫הערה‪ :‬במידה ונתון אותו הינכם רוצים להזין אינו קיים ניתן להכניס ‪ Null‬לפונקציה‪.‬‬
‫פולסים דיוור אלקטרוני‬
‫מורשה | שדרות מסריק ‪ 31‬תל אביב טל ‪ 31-0423423‬פקס ‪ 31-0420243‬כל הזכויות שמורות‪.‬‬
‫‪-AddNewClientByEmail‬‬
‫תיאור‪ :‬מאפשרת להוסיף מייל למערכת (ללא הוספת פרטים נוספים)‬
‫פרמטרים של הפונקציה‪:‬‬
‫)‪ -Password(string‬סיסמא לשימוש ב‪ .web service‬אתם תקבלו סיסמה יחודית לשימוש ב ‪Web‬‬
‫‪Service‬‬
‫)‪ -GroupID(interger‬מספר הקבוצה במערכת פולסים אליה אתם מעוניינים להוסיף את הרשימה‪.‬‬
‫)‪ -Email(string‬כתובת המייל‪.‬‬
‫)‪ -needOptin(Boolean‬האם הלקוח צריך לאשר את המייל בשביל להפעילו (‪ .)DOUBLE OPTIN‬אם‬
‫אינכם משתמשים ביכולת זו פשוט רשמו ‪.false‬‬
‫‪-AddNewClientExtended‬‬
‫פרמטרים של הפונקציה‪:‬‬
‫תיאור‪ :‬מאפשרת להוסיף מייל למערכת הכוללת את כל פרטי הלקוח כולל שדות נוספים‪.‬‬
‫)‪ -Password(string‬סיסמא לשימוש ב‪ .web service‬אתם תקבלו סיסמה יחודית לשימוש ב ‪Web‬‬
‫‪Service‬‬
‫)‪ -GroupID(interger‬מספר הקבוצה במערכת פולסים שאתם רוצים להוסיף אליה את הרשימה‬
‫)‪ -Email(string‬כתובת המייל‬
‫)‪ -First Name(string‬שם פרטי‬
‫)‪ -Last Name(string‬שם משפחה‬
‫)‪ -Birthday(date‬תאריך לידה‬
‫)‪ -City(string‬עיר‬
‫)‪ -Zip(string‬מיקוד‬
‫)‪ -Country(string‬ארץ‬
‫)‪ -State)String‬מדינה‬
‫)‪ -Company(string‬חברה‬
‫)‪-Telephone(string‬טלפון‬
‫פולסים דיוור אלקטרוני‬
‫מורשה | שדרות מסריק ‪ 31‬תל אביב טל ‪ 31-0423423‬פקס ‪ 31-0420243‬כל הזכויות שמורות‪.‬‬
‫)‪ -Cellphone)String‬טלפון סלולרי (מבנה הינו‪ XXX-XXXXXXX :‬או ‪ XXXXXXXXXX‬בלבד!‪ -‬כל מבנה‬
‫אחר ידחה)‬
‫)‪ExtraDate1(date‬‬
‫)‪ExtraDate2(date‬‬
‫)‪ExtraDate3(date‬‬
‫)‪SubAccountExtraDate(date‬‬
‫)‪ExtraField1(string‬‬
‫)‪ExtraField2(string‬‬
‫)‪ExtraField3(string‬‬
‫)‪ExtraField4(string‬‬
‫)‪ExtraField5(string‬‬
‫)‪ExtraField6(string‬‬
‫)‪ExtraField7(string‬‬
‫)‪SubAccountExtraField(string‬‬
‫)‪ -needOptin(Boolean‬האם הלקוח צריך לאשר את המייל בשביל להפעילו (‪ .)DOUBLE OPTIN‬אם‬
‫אינכם משתמשים ביכולת זו פשוט רשמו ‪false‬‬
‫)‪ -toOverWrite(Boolean‬במידה והמייל כבר קיים האם לדרוס את הנתונים הקיימים שלו‪ .‬במידה‬
‫ומוגדר כ‪ FALSE‬והמייל כבר קיים המערכת תתעלם ולא תשנה נתונים‪.‬‬
‫‪RemoveClientsFromGroups‬‬
‫תיאור‪ :‬מאפשרת למחוק כתובות דואר אלקטרונים מהחשבון‪.‬‬
‫פרמטרים של הפונקציה‪:‬‬
‫)‪ -Password(string‬סיסמא לשימוש ב‪ .web service‬אתם תקבלו סיסמה יחודית לשימוש ב ‪Web‬‬
‫‪Service‬‬
‫)‪ -GroupsID[](interger‬מערך של מספרי הקבוצות בחשבון שלכם‪.‬‬
‫)‪ -emails[](string‬מערך כתובות דואר אלקטרוני אותם הינכם רוצים למחוק מהקבוצות שנבחרו‬
‫במערך ‪. GroupsID‬‬
‫תוצאה‪ :‬כאשר הטרנזקציה עבדה מקבלים‪ "Success"-‬אחרת מקבלים הודעת שגיאה‪.‬‬
‫פולסים דיוור אלקטרוני‬
‫מורשה | שדרות מסריק ‪ 31‬תל אביב טל ‪ 31-0423423‬פקס ‪ 31-0420243‬כל הזכויות שמורות‪.‬‬
‫‪GetUnsubscribeEmailClients‬‬
‫פרמטרים של הפונקציה‪:‬‬
‫תיאור‪ :‬מאפשרת לקבל דו"ח המכיל את כתובות דואר האלקטרוני שהסירו עצמם מהמערכת על פי‬
‫טווח תאריכים מסויים‪.‬‬
‫)‪ -Password(string‬סיסמא לשימוש ב‪ .web service‬אתם תקבלו סיסמה יחודית לשימוש ב ‪Web‬‬
‫‪Service‬‬
‫)‪ -startDate(DateTime‬החל מתאריך זה הוסרו כתובות הדואר האלקטרוני מהחשבון‬
‫)‪ -endDate(DateTime‬עד תאריך זה הוסרו כתובות הדואר האלקטרוני מהחשבון‬
‫תוצאה‪ :‬מקבלים טבלה הכוללת את כתובת דואר האלקטרוני ותאריך הסרה מדויק‪.‬‬
‫הערה‪:‬‬
‫הפונקציות הנ"ל מחזירות ערך ‪ True‬או ‪. False‬‬
‫‪ : True‬הטרנזקציה הצליחה‪.‬‬
‫‪ : False‬הטרנזקציה נכשלה‪.‬‬
‫הערה‪ :‬במידה ונתון אותו הינכם רוצים להזין אינו קיים ניתן להכניס ‪ Null‬לפונקציה‪.‬‬
‫‪UnsubscribeEmailClients‬‬
‫פרמטרים של הפונקציה‪:‬‬
‫תיאור‪ :‬מאפשרת להסיר נמענים מכל החשבון‪.‬‬
‫)‪ -Password(string‬סיסמא לשימוש ב‪.web service‬‬
‫)‪ -Emails[](string‬מערך של כתובות דואר אלקטרוני שאותם הינכם רוצים להסיר מהחשבון‬
‫תוצאה‪ :‬כאשר הטרנזקציה עבדה מקבלים‪ "Success"-‬אחרת מקבלים הודעת שגיאה‪.‬‬
‫דוגמה‪:‬‬
‫על מנת להשתמש ב ‪ web service‬בשפת ה‪ dot net‬של ‪Microsoft‬‬
‫יש לבצע את הצעדים הבאים באמצעות ‪: VISUAL STUDIO 2008‬‬
‫פולסים דיוור אלקטרוני‬
‫מורשה | שדרות מסריק ‪ 31‬תל אביב טל ‪ 31-0423423‬פקס ‪ 31-0420243‬כל הזכויות שמורות‪.‬‬
Add Web ‫ יש ללחוץ על לחצן ימני של העכבר ואז לבחור‬Solution Explorer ‫) ב‬3
Reference
‫ של‬webservice ‫ יש לרשום את כתובת ה‬URL: ‫ במקום שרשום את‬-‫) נפתח חלון חדש‬4
"http://www.pulseem.co.il/Pulseem/pulseemservices.asmx" :‫פולסים‬
web service‫ את שם האוביקט ל‬Web Reference Name:‫) הכנסו ב‬1
Add Reference ‫ לדוגמה ואז לחצו על כפתור‬GlobalPulseemService :‫רשמו‬
Web ‫ יווצרו לכם אוטומטית כל האוביקטים בשביל לקרוא ל‬Add Reference ‫) אחרי לחיצה‬2
.‫ של מערכת פולסים‬Service
:Reference‫ אחרי הוספת ה‬C# ‫דוגמת קוד בשפת‬
using System;
using System.Configuration;
using System.Data;
using System.Linq;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.HtmlControls;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Xml.Linq;
using GlobalPulseemService;
Public partial class _Default : System.Web.UI.Page
{
//define a Web service proxy object.
Private GlobalPulseemService.PulseemServices proxy;
protected void btnAddClient_Click(object sender, EventArgs e)
{
proxy =
new GlobalPulseemService.PulseemServices();
DateTime birthday = Convert.ToDateTime("1/1/1990");
bool result = proxy.AddNewClient("AUfda+4hSOo47UYOWBp7kw==",
325, "[email protected]", "David", null, birthday, "TelAviv", "Haaliya
62","21321","Israel",null, "Pulseem", "03-2323232","052-2223456"
false);
}
}
:net.‫ ב‬web service ‫לדוגמה נוספת איך להשתמש ב‬
http://www.codeproject.com/KB/webservices/WebServiceConsumer.aspx
.'‫ וכו‬JAVA ,PHP ,Classic ASP ‫ ניתן לבצע בכל שפת קוד או סקריפט כגון‬Web Service‫שימוש ב‬
: ASP ‫דוגמת קוד בשפת‬
'Email varible
Dim myString
.‫ כל הזכויות שמורות‬31-0420243 ‫ פקס‬31-0423423 ‫ תל אביב טל‬31 ‫מורשה | שדרות מסריק‬
‫פולסים דיוור אלקטרוני‬
Email = "[email protected]"
'Create an object of Soap Client
SET objSoapClient = Server.CreateObject("MSSOAP.SoapClient")
objSoapClient.ClientProperty("ServerHTTPRequest") = True
'Calling Pulseem Web Service WSDL
objSoapClient.mssoapinit")http://www.pulseem.com/Pulseem/pulseemservi
ces.asmx?WSDL("
' Use the SOAP object to call the Web Method
newClient =
objSoapClient.AddNewClientByEmail("S6dC833NRRO7vOLIegWK/w==",864,Emai
l,false)
set objSoapClient = nothing
‫ של חברת‬SOAP Toolkit -‫ יש להתקין‬ASP‫ על מנת להשתמש בדוגמת הקוד הנ"ל ב‬:‫הערה‬
:‫מיקרוסופט בלינק הבא‬
http://www.microsoft.com/downloads/details.aspx?FamilyId=C943C0DD-CEEC-4088-975386F052EC8450&displaylang=en
.‫ כל הזכויות שמורות‬31-0420243 ‫ פקס‬31-0423423 ‫ תל אביב טל‬31 ‫מורשה | שדרות מסריק‬
‫פולסים דיוור אלקטרוני‬