Odczytaj saldo, walutę i wartość określającą warunki płatności konta wskazanego przez Twoje dane uwierzytelniające API. Jest to sprawdzenie salda; nie powoduje zasilenia konta ani złożenia zamówienia.
Żądanie
Używaj danych uwierzytelniających API po stronie serwera i przesyłaj je przez HTTPS. Przykłady odczytują dane uwierzytelniające ze zmiennych środowiskowych; nie zawierają działających danych uwierzytelniających. Sprawdzaj status.code w treści JSON, a także status HTTP. Te starsze procedury obsługi nie zawsze ustawiają status błędu HTTP w przypadku błędu aplikacji.
curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
"https://api.multitel.net/v3/getbalance"Nie są wymagane żadne parametry ścieżki, zapytania ani treści żądania.
Odpowiedź
Jest to przykładowa struktura odpowiedzi, a nie dane konta ani aktualna oferta cenowa.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "125.50",
"currency": "USD",
"terms": "prepaid"
}
}| Pole | Znaczenie |
|---|---|
balance | Zapisane saldo konta. Podczas przetwarzania wartości pieniężnych zachowuj precyzję dziesiętną. |
currency | Wartość waluty zapisana dla tego konta. |
terms | Zapisana dla konta wartość określająca warunki płatności. Procedura obsługi nie wylicza jej możliwych wartości ani jej nie normalizuje; nie zakładaj, że przykład wyczerpuje wszystkie możliwe wartości. |
Błędy i użytkowanie
W przypadku niepowodzenia uwierzytelniania używana jest wspólna odpowiedź API dotycząca uwierzytelniania. Ta procedura obsługi nie definiuje osobnego błędu braku salda ani stronicowania. Zwrócone saldo nie stanowi rezerwacji środków i nie gwarantuje pomyślnej realizacji późniejszego zamówienia.