Zjistěte zůstatek, měnu a hodnotu platebních podmínek účtu, ke kterému patří vaše přihlašovací údaje pro API. Jde o zjištění zůstatku; tato operace nepřidává prostředky ani nevytváří objednávku.
Požadavek
Používejte přihlašovací údaje pro API na straně serveru a připojení přes HTTPS. Příklady načítají přihlašovací údaje z proměnných prostředí; neobsahují žádné funkční přihlašovací údaje. Kontrolujte hodnotu status.code v těle JSON i stav HTTP. Tyto starší obslužné rutiny při chybě aplikace nenastavují chybový stav HTTP ve všech případech.
curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
"https://api.multitel.net/v3/getbalance"Nejsou vyžadovány žádné parametry v cestě, v dotazu ani v těle požadavku.
Odpověď
Jde o ukázkovou strukturu odpovědi, nikoli o údaje účtu nebo aktuální cenovou nabídku.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "125.50",
"currency": "USD",
"terms": "prepaid"
}
}| Pole | Význam |
|---|---|
balance | Uložený zůstatek účtu. Při zpracování peněžních hodnot zachovejte desetinnou přesnost. |
currency | Hodnota měny uložená pro tento účet. |
terms | Uložená hodnota platebních podmínek účtu. Obslužná rutina neuvádí výčet jejích možných hodnot ani ji nenormalizuje; nepředpokládejte, že příklad zahrnuje všechny možné hodnoty. |
Chyby a použití
Při selhání ověření se používá společná odpověď API pro ověřování. Tato obslužná rutina nedefinuje samostatnou chybu pro chybějící zůstatek ani stránkování. Vrácený zůstatek nepředstavuje rezervaci prostředků a nezaručuje, že pozdější objednávka bude úspěšná.