אפשרויות API של חברת ימות המשיח

[נועם חיון]

קבלת רשימת חיובי יחידות

היסטוריה של תנועת יחידות במערכת (כולל דוחות קמפיינים שהסתיימו)

הפקודה היא: GetTransactions

---

הפרמטרים הנדרשים:

פרמטר	תיאור	הערות
token	טוקן	חובה
from	מאיזה תנועה להציג	רשות
limit	מספר מרבי של תנועות שיש לכלול	רשות
filter	סינון תוצאות לפי סוג פעולה	campaigns עבור חיובי קמפיינים

---

מאפייני תגובת השרת:

מאפיין	סוג	ערך
transactions	array	מערך אובייקטים (ראה “תבנית אובייקט תנועה” להלן)
totalCount	int	מספר כולל של תנועת יחידות

---

תבנית אובייקט תנועה

מאפיין	סוג	ערך
id	int	מזהה תנועה ייחודי
transactionTime	string	תאריך ושעה (פורמט: yyyy-MM-dd HH:mm:ss)
amount	double	סכום היחידות
description	string	תיאור העסקה (ראה מילות מפתח מיוחדות להלן)
who	string	בוצע על ידי: <br>1) כתובת IP אם דרך אתר האינטרנט. <br>2) מספר טלפון אם דרך הטלפון. <br>3) ADMIN אם ע״י שירות הלקוחות. <br>4) TRANSFER בהעברת יחידות. <br>5) expire במקרה של פג תוקף.
newBalance	double	כמות יחידות מחודשת לאחר התנועה
expireDate	string	תאריך תפוגה חדש (אם קיים) בפורמט yyyy-MM-dd, אחרת null
campaignId	string	מזהה קמפיין אם התנועה היא הפעלת קמפיין (משמש להורדת דוח), אחרת null

---

מילות מפתח מיוחדות למאפיין description

ניתן להשתמש בהן כדי לזהות סוגי פעולות:

תיאור המתחיל ב	פירושו
Start-	חיוב עבור הפעלת קמפיין
transfer to	חיוב עבור העברת יחידות למערכת אחרת
transfer from	יחידות שנוספו בהעברה ממערכת אחרת
Units expired	פג תוקף היחידות

[נועם חיון]

עדכון פרטי משתמש

הערה: הפקודה מוחקת את פרטי המשתמש המעודכנים במערכת.

הפקודה היא: SetCustomerDetails

---

הפרמטרים הנדרשים:

פרמטר	תיאור
token	טוקן (פרמטר חובה)
name	שם לקוח
email	כתובת דוא"ל
organization	שם ארגון
contactName	שם איש קשר
phones	טלפון
invoiceName	חשבונית על שם
invoiceAddress	כתובת למשלוח חשבונית
fax	פקס
accessPassword	סיסמת גישה
recordPassword	סיסמת הקלטות

---

אין מאפיינים מיוחדים בתגובת השרת

[נועם חיון]

שינוי סיסמת ניהול

הפקודה היא: SetPassword

---

הפרמטרים הנדרשים:

פרמטר	תיאור / הערות
token	טוקן
password	סיסמת הניהול הנוכחית
newPassword	סיסמה חדשה

---

אין מאפיינים מיוחדים בתגובת השרת

[נועם חיון]

קבלת פרטי המערכת

הפקודה היא: GetSession

---

הפרמטרים הנדרשים:

פרמטר	תיאור / הערות
token	טוקן

---

מאפייני תגובת השרת:

מאפיין	סוג	ערך
name		שם לקוח
unitsExpireDate	string	תאריך תפוגה של היחידות
email		כתובת אימייל
organization		שם ארגון
contactName		שם איש קשר
phones		טלפון
invoiceName		חשבונית על שם
invoiceAddress		כתובת למשלוח חשבונית
fax		פקס
accessPassword		סיסמת גישה למערכת
units	double	כמות היחידות שבמערכת
recordPassword		סיסמת הקלטות
creditFile		שם משווק
username	string	מספר המערכת

[נועם חיון]

התנתקות

מחיקת הטוקן שהתקבל בהתחברות

הפקודה היא: Logout

---

הפרמטרים הנדרשים:

פרמטר	תיאור / הערות
token	טוקן

---

אין מאפיינים מיוחדים בתגובת השרת

[נועם חיון]

התחברות

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

הפקודה היא: Login

---

הפרמטרים הנדרשים:

פרמטר	תיאור / הערות
username	מספר מערכת
password	סיסמת ניהול של המערכת

---

מאפייני תגובת השרת:

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

---

שימו לב:

אין צורך נוספת ליצירת טוקן ללא בקשת Login.
כאשר שולחים כל פקודת API, לרבות פקודת token, יש לכתוב בצורה הבאה (פורמט username:password):

${url}<WebServiceName>?token=${username}:${password}

[נועם חיון]

הסיסמה היא (copy:123456)

[נועם חיון]

התחברות

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

הפקודה היא -Login

הפרמטרים הנדרשים:

פרמטר תיאור / הערות
username מספר מערכת
password סיסמת הניהול של המערכת
מאפייני תגובת השרת:

מאפיין ערך הערה
token טוקן הטוקן שנוצר יפוג לאחר 30 דקות אם לא תתבצע שיחת API עם הטוקן. כמו כן, כל עוד הטוקן תקף יש להשתמש בו ולהימנע מבקשת התחברות נוספת
שימו לב!
ישנה דרך נוספת ליצירת טוקן ללא צורך בבקשת Login
כאשר שולחים כל פקודת API, לרשום בפרמטר token מספר מערכת : סיסמא (username:password)

לדוגמה: