Brick API Documentation
Brick

โครงสร้างการตอบสนอง API

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

การตอบสนองความสำเร็จ

Sample of Sync Response

JSONCode
{ "status": 202, data:{ "message": "We are processing your request and will send the data in the callback URL." “job_id”:”XXXX-XXXX-XXXX-XXXX” }, metadata:{ "source": {{API/Widget/Dashboard/SDK/Portal}}, "entity": {{Data/Insight/Verification/Payment}} }, error: null, }

Field description

สนามคำอธิบาย
สถานะรหัสสถานะ HTTP/HTTPS
ข้อความข้อความ
job_idธุรกรรมที่ไม่ซ้ำใคร_id ซึ่งจะช่วยแมปการตอบสนอง Async
แหล่งที่มาโดยจะกำหนดที่มาของคำขอ APIs โดยอาจเป็นคำขอจาก API, Widget, Dashabord, SDK หรือ Portal
เอนทิตีโดยกำหนดว่าผลิตภัณฑ์ใดที่คำขอ APIs มาจาก โดยอาจเป็นผลิตภัณฑ์ใดจากข้อมูล ข้อมูลเชิงลึก การยืนยัน หรือการชำระเงิน
ข้อผิดพลาดในกรณีที่สำเร็จ ข้อผิดพลาดจะเป็นโมฆะ

Sample of Async Response

JSONCode
{ "status": 200, "data": { "message": “We are successfully able to fetch data”, "example-1":"XXXX-XXXX-XXXX", "count":{{Number of objects}}, "example-2"{[ "array1":1, "example-3":"xx-xx-xx" ],[ "array2":1, "example-4":"xx-xx-xx" ]} }, metadata:{ "source": {{API/Widget/Dashboard/SDK/Portal}}, "entity": {{Data/Insight/Verification/Payment}} }, error: null }

Field description

สนามคำอธิบาย
สถานะรหัสสถานะ HTTP/HTTPS
ข้อความข้อความ
ข้อมูลข้อมูลการตอบสนอง
แหล่งที่มาโดยจะกำหนดที่มาของคำขอ APIs โดยอาจเป็นคำขอจาก API, Widget, Dashabord, SDK หรือ Portal
เอนทิตีโดยกำหนดว่าผลิตภัณฑ์ใดที่คำขอ APIs มาจาก โดยอาจเป็นผลิตภัณฑ์ใดจากข้อมูล ข้อมูลเชิงลึก การยืนยัน หรือการชำระเงิน
ข้อผิดพลาดในกรณีที่สำเร็จ ข้อผิดพลาดจะเป็นโมฆะ

การตอบสนองข้อผิดพลาด

Sample of error response

JSONCode
{ "status" : XXX, “error”:{ "code": {{brick_unique_error_code}}, "message": {{description_of_error}}, "action": {{further_action}}, "reason": {{Actual_reason_for_error}} }, “metadata”:{ "source": {{API/Widget/Dashboard/SDK/Portal}}, "entity": {{Auth/Insight/Verification/Payment}} }, data:null }

Field description

สนามคำอธิบาย
สถานะรหัสสถานะ HTTP/HTTPS
รหัสรหัสสถานะที่กำหนดเอง Brick
ข้อความข้อความ
การกระทำการดำเนินการเพิ่มเติมเพื่อป้องกันข้อผิดพลาดนี้
แหล่งที่มาโดยจะกำหนดที่มาของคำขอ APIs โดยอาจเป็นคำขอจาก API, Widget, Dashabord, SDK หรือ Portal
เอนทิตีโดยกำหนดว่าผลิตภัณฑ์ใดที่คำขอ APIs มาจาก โดยอาจเป็นผลิตภัณฑ์ใดจากข้อมูล ข้อมูลเชิงลึก การยืนยัน หรือการชำระเงิน
ข้อผิดพลาดในกรณีที่สำเร็จ ข้อผิดพลาดจะเป็นโมฆะ

คุณสามารถอ้างอิงรหัสข้อผิดพลาดที่เป็นไปได้ทั้งหมดได้ใน error handling section.


Last modified on