Hae API-tunnuksiasi vastaavan tilin saldo, valuutta ja maksuehtojen arvo. Tämä on saldokysely; se ei lisää varoja eikä tee tilausta.
Pyyntö
Käytä palvelinpuolen API-tunnuksia HTTPS-yhteyden kautta. Esimerkit lukevat tunnukset ympäristömuuttujista; ne eivät sisällä toimivia tunnuksia. Tarkista JSON-rungon status.code sekä HTTP-tila. Nämä vanhat käsittelijät eivät johdonmukaisesti aseta HTTP-virhetilaa sovellusvirheen yhteydessä.
curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
"https://api.multitel.net/v3/getbalance"Polku-, kysely- tai runkoparametreja ei tarvita.
Vastaus
Tämä on havainnollistava esimerkki vastauksen rakenteesta, ei tilitietoja eikä ajantasainen hintatarjous.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "125.50",
"currency": "USD",
"terms": "prepaid"
}
}| Kenttä | Merkitys |
|---|---|
balance | Tallennettu tilin saldo. Säilytä desimaalitarkkuus rahamääriä käsitellessäsi. |
currency | Tälle tilille tallennettu valuutan arvo. |
terms | Tilille tallennettu maksuehtojen arvo. Käsittelijä ei luettele mahdollisia arvoja eikä normalisoi arvoa; älä oleta, että esimerkki kattaa kaikki mahdolliset arvot. |
Virheet ja käyttö
Todennuksen epäonnistuessa käytetään API:n yhteistä todennusvastausta. Tämä käsittelijä ei määrittele erillistä virhettä puuttuvalle saldolle eikä sivutusta. Palautettu saldo ei ole varojen varaus eikä takaa myöhemmän tilauksen onnistumista.