ACCOUNT

บริการ Account API เป็นช่องทางการตรวจสอบการยืนยันตัวตน และตรวจสอบข้อมูลเครดิตของผู้ใช้งาน โดยมีการแจ้งการใช้งานเครดิตจำนวนเท่าไร หรือ คงเหลือเครดิตจำนวนเท่าไร และมีการแยกประเภทการชำระเงินได้อีกด้วย

API Get Balance

ใช้สำหรับตรวจสอบข้อมูล Credit ของผู้ใช้งาน โดยแยกเป็นประเภทการชำระเงิน Prepaid (ชำระก่อนใช้เครดิต) และ Postpaid (ใช้เครดิตก่อนชำระ)

Sequence Diagram

รูปภาพ Sequence Diagram (API Balance)

Request

ผู้ใช้งานสามารถเริ่มสร้าง HTTP ตามรายละเอียดดังนี้

หัวข้อ	รายละเอียด
HTTP Request (URL)	https://api-service.ants.co.th/account/balance
HTTP Headers	Content-Type: application/json Authorization: (Basic Auth) Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP Methods	POST

ตัวอย่าง Request (method : Post)

HTTP Request (URL): https://api-service.ants.co.th/account/balance

Response

Response ตอบกลับผู้ใช้งาน ดังนี้

ชุดข้อมูลผลลัพธ์	ประเภทข้อมูล	รายละเอียด
type	String	ประเภทการชำระเงิน
credit	Number	จำนวนเครดิต

ตัวอย่าง Response JSON

{
    "type": "postpaid",
    "credit": 167.00
}

สถานะผลลัพธ์ตอบกลับ (Response Status)

ในการใช้งาน API ท่านจะได้รับสถานะตอบกลับต่าง ๆ เพื่อที่จะเข้าใจถึงเหตุผล ปัจจัยต่าง ๆ และสามารถแก้ไขปัญหาได้ตรงจุด ข้อมูลด้านล่างเป็นการอธิบายรายการของรหัส แหตุผล และคำอธิบายต่าง ๆ

HTTP Status Code

ทุก ๆรายการของ HTTP transaction จะมีรหัสสถานะส่งกลับมาจาก server เพื่อบ่งบอกว่า server ประมวลผลแต่ละรายการ transaction อย่างไร ซึ่งส่วนใหญ่สถานะ จะแสดงเป็น 200 OK และ 404 Not Found ให้สังเกตุว่าหาก Response header HTTP status code แสดงค่าเป็น 200 OK แสดงว่าข้อความจะถูกส่งตาม Request body ถูกต้อง