קריאת יתרת החשבון

קראו את היתרה, המטבע וערך תנאי התשלום של החשבון המזוהה באמצעות פרטי הגישה שלכם ל-API. זוהי שאילתה לבירור יתרה; היא אינה מוסיפה כספים ואינה מבצעת הזמנה.

בקשה

השתמשו בפרטי גישה ל-API בצד השרת באמצעות HTTPS. הדוגמאות קוראות את פרטי הגישה ממשתני סביבה; הן אינן מכילות פרטי גישה פעילים. בדקו את status.code בגוף ה-JSON וכן את סטטוס ה-HTTP. רכיבי הטיפול הוותיקים האלה אינם מגדירים באופן עקבי סטטוס שגיאת HTTP עבור שגיאה ברמת היישום.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/getbalance"

לא נדרשים פרמטרים בנתיב, בשאילתה או בגוף הבקשה.

תגובה

זהו מבנה תגובה להמחשה, ולא נתוני חשבון או הצעת מחיר עדכנית.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}

שגיאות ושימוש

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