מיקרופיי · מרכז מפתחים מרכז מפתחים · ניהול תתי מנהלים

API לניהול יתרות תתי מנהלים

עודכן לאחרונה: 10 ביוני 2026 · נתמך ב-HTTP GET, POST ו-JSON

ממשק ניהול תתי המנהלים של מיקרופיי מאפשר לבדוק ולעדכן את יתרת הודעות הסמס וההודעות הקוליות של תת מנהל. ניתן להוסיף או להפחית הודעות ולבדוק את היתרה הנוכחית, ישירות ממערכות חיצוניות. הפנייה מתבצעת ב-HTTPS, בשיטת HTTP GET/POST או JSON, ומאומתת באמצעות טוקן עם הרשאת ניהול תת מנהלים.

כתובת הממשק
/extApi/manageSu.php
שיטות נתמכות
HTTP GET · POST · JSON
אימות
טוקן עם הרשאת ניהול תת מנהלים
פעולות
עדכון יתרה · בדיקת יתרה

סקירת הממשק

ממשק זה מאפשר לבצע בדיקה ועדכון של יתרת הודעות הסמס וההודעות הקוליות של תת המנהל. הפעולה הרצויה נבחרת בפרמטר act, וסוג ההודעות (סמס או קולי) בפרמטר type. בעדכון ניתן להוסיף הודעות (כמות חיובית) או להפחית (כמות שלילית).

כתובת הממשק ושיטת השליחה

הכתובת לפנייה לממשק ניהול תתי המנהלים היא:

Endpoint 
https://www.micropay.co.il/extApi/manageSu.php

לכתובת זו מוסיפים את הפרמטרים המתאימים. חלק מהפרמטרים הם חובה וחלקם רשות. יש לשלוח את כל שמות הפרמטרים באותיות קטנות (Lower Case). ניתן להעביר את הפרמטרים בשיטת GET או POST, או לשלוח אותם בגוף הבקשה בפורמט JSON.

אימות וטוקן

כל קריאה דורשת פרמטר token, טוקן שיצרת במערכת עם הרשאת ניהול תת מנהלים.

היכן יוצרים טוקן? במערכת מיקרופיי, בתפריט הראשי בחר ב"ניהול חשבון ותתי מנהלים" ולאחר מכן ב"טוקנים לממשקים". ראו פירוט מלא בעמוד אימות וטוקנים.

פרמטרים

פרמטרחובהתיאור
tokenחובהטוקן הזדהות שיצרת במערכת, עם הרשאת ניהול תת מנהלים.
suidחובהקוד תת המנהל שאותו רוצים לנהל. ניתן לראות את הקוד בטבלת תתי המנהלים במערכת.
actחובה הפעולה שתרצה לבצע. האפשרויות:
• creditupdate: עדכון יתרת ההודעות של תת המנהל (הוספה או הפחתה).
• creditcheck: בדיקת יתרת ההודעות של תת המנהל.
typeחובה סוג ההודעות שתרצה לעדכן או לבדוק. האפשרויות:
• sms: הודעות סמס.
• vms: הודעות קוליות.
amountלעדכוןכמות ההודעות להוספה או הפחתה, נדרש רק בפעולת creditupdate. כמות חיובית מוסיפה הודעות; להפחתה שלחו מספר שלילי, לדוגמה -100 להפחתה של 100 הודעות.
get / postחובהמציין למערכת באיזו שיטה נשלחו הפרמטרים. יש לשלוח אחד מהם בלבד: get=1 בשליחת GET, או post=2 בשליחת POST. הפרמטר אינו משנה את שיטת השליחה בפועל, אלא רק מצהיר עליה. (בפורמט JSON אין צורך בפרמטר זה.)

דוגמאות קוד

הדוגמאות מוצגות ב-cURL, לכל פעולה דוגמה בפרמטרים (name=value) ודוגמה ב-JSON.

הוספת הודעות (creditupdate)

בסיסי · HTTP GET 
# הוספת 100 הודעות סמס
curl "https://www.micropay.co.il/extApi/manageSu.php?get=1&token=XXXXX&suid=10025&act=creditupdate&type=sms&amount=100"
בסיסי · JSON 
curl -X POST https://www.micropay.co.il/extApi/manageSu.php \
  -H "Content-Type: application/json" \
  -d '{"token":"XXXXX","suid":"10025","act":"creditupdate","type":"sms","amount":"100"}'

הפחתת הודעות (כמות שלילית)

JSON 
# הפחתת 100 הודעות קוליות
curl -X POST https://www.micropay.co.il/extApi/manageSu.php \
  -H "Content-Type: application/json" \
  -d '{"token":"XXXXX","suid":"10025","act":"creditupdate","type":"vms","amount":"-100"}'

בדיקת יתרה (creditcheck)

בסיסי · HTTP GET 
# בדיקת יתרת הודעות קוליות
curl "https://www.micropay.co.il/extApi/manageSu.php?get=1&token=XXXXX&suid=10025&act=creditcheck&type=vms"
בסיסי · JSON 
curl -X POST https://www.micropay.co.il/extApi/manageSu.php \
  -H "Content-Type: application/json" \
  -d '{"token":"XXXXX","suid":"10025","act":"creditcheck","type":"vms"}'
איך מפעילים את מצב ה-JSON? הדרך המומלצת היא לשלוח את הבקשה עם הכותרת Content-Type: application/json, כפי שמופיע בדוגמאות. אם אינך יכול לקבוע כותרות בבקשה, תוכל במקום זאת להוסיף json=1 בכתובת ה-URL ולשלוח את גוף ה-JSON ב-POST.

תשובת השרת

המערכת מחזירה תשובה כטקסט פשוט. במצב JSON מוחזר מבנה אחיד הכולל את action (הפעולה, תמיד באותיות קטנות: creditupdate / creditcheck), ובהצלחה גם את היתרה ב-data.credit. data כולל תמיד את remoteIP.

תשובה רגילה (טקסט)

Plain text 
# הצלחה: OK ואחריו היתרה הנוכחית
OK 1600

# תוצאות אחרות
PRICE_CHANGED
AMOUNT_MISMATCH
NOT_ENOUGH_CREDIT
ERROR --> Description: suid parameter, sub-user not found

תשובה ב-JSON

JSON 
// הצלחה, היתרה הנוכחית ב-data.credit
{"status":1,"action":"creditupdate","message":"OK","data":{"credit":1600,"remoteIP":"203.0.113.10"}}

// בדיקת יתרה
{"status":1,"action":"creditcheck","message":"OK","data":{"credit":1500,"remoteIP":"203.0.113.10"}}

// שגיאת פרמטר
{"status":0,"action":"creditupdate","message":"ERROR","data":{"description":"suid parameter, sub-user not found","remoteIP":"203.0.113.10"}}

טבלת קודי תשובה

ערךstatus ב-JSONמשמעות
OK1הפעולה הצליחה. בטקסט מופיע אחריו יתרת ההודעות הנוכחית; ב-JSON היתרה ב-data.credit. אם בוצעה הוספה או הפחתה, מוצגת היתרה לאחר הפעולה.
PRICE_CHANGED1חל שינוי בתמחור ההודעות. יש לבצע איפוס: להפחית את כל היתרה הקיימת, ואז להוסיף את ההודעות מחדש.
AMOUNT_MISMATCH1הכמות שמנסים להפחית גדולה מיתרת ההודעות של תת המנהל.
NOT_ENOUGH_CREDIT1הכמות שמנסים להוסיף גדולה מיתרת ההודעות בחשבון הראשי.
ERROR0שגיאה באחד הפרמטרים. בטקסט מופיע רווח ותיאור; ב-JSON התיאור נמצא ב-data.description.

שאלות נפוצות

אילו פעולות אפשר לבצע על יתרת תת מנהל?

עדכון היתרה (creditupdate), כלומר הוספה או הפחתה של הודעות, ובדיקת היתרה (creditcheck). הפעולה נבחרת בפרמטר act, וסוג ההודעות בפרמטר type.

איך מפחיתים הודעות מתת מנהל?

בפעולת creditupdate שולחים ב-amount מספר שלילי, לדוגמה -100 להפחתת 100 הודעות. כמות חיובית מוסיפה הודעות.

מה המשמעות של התשובה PRICE_CHANGED?

חל שינוי בתמחור ההודעות. יש לבצע איפוס: להפחית את כל יתרת ההודעות הקיימת, ואז להוסיף את ההודעות מחדש.

איך מקבלים את היתרה הנוכחית של תת מנהל?

שולחים act=creditcheck עם type מתאים. התשובה OK כוללת את היתרה: בטקסט אחרי הרווח, וב-JSON בשדה data.credit.

ממשקים קשורים

יתרת סמסשליחת סמסהודעות קוליותמוסכמות ופורמט תשובהמילון מונחים: תת מנהל
רוצה לנהל יתרות תתי מנהלים דרך ה-API?
פתח חשבון, צור טוקן והרץ את הדוגמה הראשונה תוך דקות
פתח חשבון חינם