Zhvilluesit

GET/v3/getbalance

Lexoni gjendjen e llogarisë

Lexoni gjendjen, monedhën dhe kushtet e pagesës të ruajtura për llogarinë tuaj API.

Në këtë faqe
  1. Kërkesa
  2. Përgjigjja
  3. Gabimet dhe përdorimi

Lexoni gjendjen, monedhën dhe vlerën e kushteve të pagesës të llogarisë që përfaqësohet nga kredencialet tuaja API. Ky është një kontroll i gjendjes; ai nuk shton fonde dhe nuk kryen porosi.

Kërkesa

Përdorni kredencialet API në anën e serverit përmes HTTPS. Shembujt i lexojnë kredencialet nga ndryshoret e mjedisit; ata nuk përmbajnë kredenciale funksionale. Kontrolloni status.code në trupin JSON, si edhe statusin HTTP. Këta përpunues të vjetër nuk caktojnë gjithmonë një status gabimi HTTP kur ndodh një gabim i aplikacionit.

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

Nuk kërkohen parametra në shteg, në vargun e kërkimit apo në trupin e kërkesës.

Përgjigjja

Kjo strukturë përgjigjeje shërben si ilustrim dhe nuk përmban të dhëna të llogarisë apo një ofertë çmimi aktuale.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
Fushat e përgjigjes për gjendjen e llogarisë
FushaKuptimi
balanceGjendja e ruajtur e llogarisë. Ruani saktësinë dhjetore kur përpunoni vlera monetare.
currencyVlera e monedhës e ruajtur për këtë llogari.
termsVlera e ruajtur e kushteve të pagesës të llogarisë. Përpunuesi nuk i rendit vlerat e mundshme dhe nuk e normalizon këtë vlerë; mos supozoni se shembulli përfshin të gjitha vlerat e mundshme.

Gabimet dhe përdorimi

Në rast dështimi të autentikimit, përdoret përgjigjja e përbashkët e autentikimit të API-së. Ky përpunues nuk përcakton ndonjë gabim të veçantë për mungesën e gjendjes së llogarisë dhe as ndarje në faqe. Gjendja e kthyer nuk përbën rezervim fondesh dhe nuk garanton se një porosi e mëvonshme do të përfundojë me sukses.