ממשק זה מיועד לביצוע אימות של מספר טלפון לשימוש כזיהוי שולח בהודעות סמס בלבד, בהתאם להנחיות משרד התקשורת.
הזיהוי מתבצע על ידי שליחת סמס או הודעה קולית עם קוד למספר המבוקש, ושליחת הקוד שהתקבל למערכת.
לאחר האימות, מספר הטלפון יאושר אוטומטית במערכת ומול המפעילים, וניתן יהיה לשלוח אותו מידית כזיהוי שולח.
הממשק מאפשר לאמת מספרי טלפון נייחים וניידים ישראלים בלבד, ולא ניתן לאמת מספרי 1800, 1700, מספרי חו"ל ואחרים.
השליחה מתבצעת באמצעות API בפרוטוקול HTTPS סטנדרטי המאפשר העברת הפרמטרים בשיטת GET או POST.
הכתובת לפנייה לממשק לאימות זיהוי שולח היא:
https://www.micropay.co.il/extApi/senderVerify.php
לכתובת הזו יש להוסיף את הפרמטרים המתאימים על מנת לבצע את האימות
חלק מהפרמטרים הינם חובה, וחלקם רשות
יש לשלוח את כל השמות של הפרמטרים ב- Lower Case
רשימת הפרמטרים לביצוע שליחה
token – טוקן שיצרת במערכת, עם הרשאה לשירותי סמס
ניתן לפתוח ולנהל את הטוקנים על ידי כניסה למערכת, לחיצה על האייקון הירוק למעלה משמאל, ובחירה באפשרות "טוקנים לממשקים"
phone – מספר הטלפון אותו תרצה לאמת
יש לשלוח מספר טלפון נייח או נייד, עם ספרות בלבד.
קביעת שיטת השליחה: GET או POST
ניתן לשלוח את הפרמטרים בשיטת GET או POST
במידה ואתה מבצע את השליחה בשיטת GET יש להוסיף את הפרמטר: get=1
במידה ואתה שולח בשיטת POST יש להוסיף את הפרמטר post=2
שים לב, הגדרת הפרמטר אינה משנה את שיטת השליחה, אלא רק מגדירה למערכת את סוג השליחה שבחרת
אתה צריך לבצע את השליחה בשיטה המתאימה בקוד עצמו
פרמטר לפנייה הראשונה לקבלת קוד
type – קובע כיצד לשלוח את הקוד למספר הטלפון
המערכת מאפשרת לך לקבוע באופן עצמאי האם לשלוח סמס או הודעה קולית עם קוד, וניתן גם לאפשר למערכת להחליט לבד כיצד לשלוח את הקוד (הודעה קולית לנייח וסמס לנייד), האפשרויות הן:
sms – המערכת תשלח הודעת סמס עם הקוד לאימות
vms – המערכת תשלח הודעה קולית עם הקוד לאימות
auto – המערכת תחליט לבד האם לשלוח סמס או הודעה קולית
שים לב, המערכת מאפשר לבקש עד שתי הודעות אימות בסמס ועד שתי הודעות אימות בהודעה קולית בפרק זמן של 15 דקות לאותו מספר טלפון, שליחת בקשות נוספות תחזיר הודעת שגיאה
פרמטר לפנייה השנייה לאימות הקוד שהתקבל
code – הקוד שהתקבל במספר הטלפון המבוקש
פרמטר נוסף שאינו חובה
desc – מאפשרת לשלוח טקסט של עד כ- 50 תווים שישמר כתיאור המספר במערכת, התיאור מופיע בשליחה ידנית במערכת בחלונית זיהוי שולח שמורים
יש לשלוח את הפרמטר הזה בפניה השנייה עם קוד האימות שהלקוח קיבל
דוגמאות שליחה בשיטת GET
להלן דוגמא לפנייה לשליחת קוד אימות למספר טלפון
https://www.micropay.co.il/extApi/senderVerify.php?get=1&token=xxxxx&phone=0540000000&type=auto
להלן דוגמא לפנייה לאימות קוד שהתקבל בטלפון
https://www.micropay.co.il/extApi/senderVerify.php?get=1&token=xxxxx&phone=0540000000&code=xxxxx
התשובה שמתקבלת מהמערכת
המערכת תחזיר תשובה כטקסט פשוט, להלן התשובות האפשריות:
ERROR – יוחזר במידה ויש שגיאה באחד הפרמטרים או בתהליך, ולאחריו רווח ותיאור של השגיאה
PHONE_EXIST – יוחזר במידה והמספר המבוקש כבר קיים במערכת
CODE_SENT – יוחזר לאחר שהמערכת קיבלה בקשה לשליחת קוד אימות, והקוד נשלח
MAX_SENT – יוחזר במידה והתקבלו מעל 4 בקשות לשליחת קוד תוך 15 דקות (2 בקשות לסמס ו- 2 בקשות להודעה קולית, או 4 בקשות עם auto)
WRONG_CODE – יוחזר במידה והקוד ששלחת אינו תואם לקוד שנשלח למספר טלפון על ידי המערכת
OK – יוחזר בסיום התהליך, לאחר שהקוד אומת והמספר התווסף כזיהוי שולח מאומת למערכת