API לבדיקת יתרת סמס בחשבון
ממשק בדיקת יתרת הסמס של מיקרופיי מאפשר לבדוק את יתרת הודעות הסמס בחשבון, לשליחה בישראל. הבדיקה מתבצעת על אותו ממשק השליחה
(scheduleSms.php) עם הפרמטר act=credit, והמערכת מחזירה מספר עם היתרה. הפנייה מתבצעת ב-HTTPS, ב-GET/POST או JSON, ומאומתת באמצעות טוקן עם הרשאת שירותי סמס.
סקירת הממשק
ממשק זה מאפשר לבדוק את יתרת הודעות הסמס בחשבון. ניתן לבדוק רק את יתרת ההודעות לשליחה בישראל. הבדיקה מתבצעת על כתובת ממשק שליחת הסמס,
scheduleSms.php, עם הפרמטר act=credit.
כתובת הממשק ושיטת השליחה
הכתובת לבדיקת היתרה היא:
https://www.micropay.co.il/extApi/scheduleSms.php
יש לשלוח את כל שמות הפרמטרים באותיות קטנות (Lower Case). ניתן להעביר את הפרמטרים בשיטת GET או POST, או לשלוח אותם בגוף הבקשה בפורמט JSON.
אימות וטוקן
הבקשה דורשת פרמטר token, טוקן שיצרת במערכת עם הרשאת שירותי סמס.
פרמטרים
| פרמטר | חובה | תיאור |
|---|---|---|
token | חובה | טוקן הזדהות שיצרת במערכת, עם הרשאת שירותי סמס. |
act | חובה | יש לשלוח עם הערך credit כדי לבצע בדיקת יתרה. |
get / post | חובה | מציין למערכת באיזו שיטה נשלחו הפרמטרים. יש לשלוח אחד מהם בלבד: get=1 בשליחת GET, או post=2 בשליחת POST. הפרמטר אינו משנה את שיטת השליחה בפועל, אלא רק מצהיר עליה. (בפורמט JSON אין צורך בפרמטר זה.) |
דוגמאות קוד
curl "https://www.micropay.co.il/extApi/scheduleSms.php?get=1&token=XXXXX&act=credit"curl -X POST https://www.micropay.co.il/extApi/scheduleSms.php \ -H "Content-Type: application/json" \ -d '{"token":"XXXXX","act":"credit"}'
Content-Type: application/json, כפי שמופיע בדוגמאות.
אם אינך יכול לקבוע כותרות בבקשה, תוכל במקום זאת להוסיף json=1 בכתובת ה-URL ולשלוח את גוף ה-JSON ב-POST.
תשובת השרת
בקריאה רגילה המערכת מחזירה מספר עם יתרת ההודעות. במצב JSON, message הוא OK, היתרה נמצאת בשדה data.credit (מספר), ושדה action הוא credit. data כולל תמיד את remoteIP.
תשובה רגילה (טקסט)
# יתרת ההודעות 15000 # שגיאה ERROR --> Description: token parameter, invalid or missing
תשובה ב-JSON
// היתרה ב-data.credit {"status":1,"action":"credit","message":"OK","data":{"credit":15000,"remoteIP":"203.0.113.10"}} // שגיאת פרמטר {"status":0,"action":"credit","message":"ERROR","data":{"description":"token parameter, invalid or missing","remoteIP":"203.0.113.10"}}
טבלת קודי תשובה
| ערך | status ב-JSON | משמעות |
|---|---|---|
| מספר | 1 | יתרת הודעות הסמס בחשבון. בטקסט מוחזר המספר עצמו; ב-JSON היתרה ב-data.credit ו-message הוא OK. |
ERROR | 0 | שגיאה באחד הפרמטרים. בטקסט מופיע רווח ותיאור; ב-JSON התיאור נמצא ב-data.description. |
שאלות נפוצות
איך בודקים את יתרת הסמס בחשבון?
פונים לכתובת scheduleSms.php עם הטוקן והפרמטר act=credit. המערכת מחזירה מספר עם היתרה; במצב JSON היתרה בשדה data.credit.
איזו יתרה הממשק מחזיר?
את יתרת הודעות הסמס בחשבון לשליחה בישראל בלבד.
איך בודקים את יתרת הסמס של תת מנהל?
שולחים טוקן המשויך לתת המנהל, והמערכת מחזירה את יתרת ההודעות של אותו תת מנהל.