ממשק זה מאפשר לבצע בדיקה ועדכון של יתרת הודעות הסמס וההודעות הקוליות של תת המנהל.
הפנייה מתבצעת באמצעות API בפרוטוקול HTTPS סטנדרטי המאפשר העברת הפרמטרים בשיטת GET או POST.
הכתובת לפנייה לממשק ניהול אנשי קשר היא:
https://www.micropay.co.il/extApi/manageSu.php
לכתובת הזו יש להוסיף את הפרמטרים המתאימים על מנת לבצע את האימות
חלק מהפרמטרים הינם חובה, וחלקם רשות
יש לשלוח את כל השמות של הפרמטרים ב- Lower Case
רשימת הפרמטרים הבסיסית לפנייה לממשק
token – טוקן שיצרת במערכת, עם הרשאה לניהול תת מנהלים
ניתן לפתוח ולנהל את הטוקנים על ידי כניסה למערכת, לחיצה על האייקון הירוק למעלה משמאל, ובחירה באפשרות "טוקנים לממשקים"
suid – קוד תת המנהל שאותו רוצים לנהל, ניתן לראות את הקוד בטבלת תתי המנהלים במערכת
act – הפעולה שתרצה לבצע, יש לבחור מהאפשרויות הבאות:
- creditupdate – עדכון יתרת ההודעות של תת המנהל
- creditcheck – בדיקת יתרת ההודעות של תת המנהל
type – סוג ההודעות שתרצה לעדכן/לבדוק, יש לבחור מהאפשרויות הבאות:
- sms – הודעות סמס
- vms – הודעות קוליות
amount – כאשר רוצים לבצע עדכון ליתרת ההודעות, יש לשלוח בפרמטר הזה את הכמות הודעות שתרצה להוסיף/להפחית, כאשר על מנת להפחית הודעות יש לשלוח את הסימן מינוס לפני הכמות.
לדוגמא, להפחתה של 100 הודעות סמס, יש לשלוח את הערך: 100-
קביעת שיטת השליחה: GET או POST
ניתן לשלוח את הפרמטרים בשיטת GET או POST
במידה ואתה מבצע את השליחה בשיטת GET יש להוסיף את הפרמטר: get=1
במידה ואתה שולח בשיטת POST יש להוסיף את הפרמטר post=2
שים לב, הגדרת הפרמטר אינה משנה את שיטת השליחה, אלא רק מגדירה למערכת את סוג השליחה שבחרת
אתה צריך לבצע את השליחה בשיטה המתאימה בקוד עצמו
דוגמאות שליחה בשיטת GET
להלן דוגמא להוספת 100 הודעות סמס
https://www.micropay.co.il/extApi/manageSu.php?get=1&token=xxxxx&suid=xxxxx&act=creditupdate&type=sms&amount=100
להלן דוגמא לבדיקת כמות הודעות קוליות
https://www.micropay.co.il/extApi/manageSu.php?get=1&token=xxxxx&suid=xxxxx&act=creditcheck&type=vms
רשימת תשובות אפשרויות שמתקבלות בבדיקת סטטוס איש קשר
המערכת תחזיר תשובה כטקסט פשוט, להלן התשובות האפשריות:
ERROR – יוחזר במידה ויש שגיאה באחד הפרמטרים, ולאחריו רווח ותיאור של השגיאה
PRICE_CHANGED – יוחזר במידה וישנו שינוי בתמחור של ההודעות, במקרה הזה יש לבצע איפוס של ההודעות על ידי הפחתת כל היתרה, ואז לבצע הוספת הודעות מחדש
AMOUNT_MISMATCH – יוחזר במידה והכמות הודעות שאותה מנסים להפחית גדולה מיתרת ההודעות של תת המנהל
NOT_ENOUGH_CREDIT – יוחזר במידה והכמות הודעות שאותה מנסים להוסיף לתת מנהל גדולה מיתרת ההודעות בחשבון
OK – יוחזר במידה והכל תקין, ולאחריו רווח ויתרת ההודעות הנוכחית (במידה ובוצעה הוספה או הפחתה של ההודעות, תופיע היתרה המתאימה לאחר ביצוע הפעולה)