รหัสข้อผิดพลาด (Error codes)

ทุก response ของ Open API จะมี field status ครอบไว้เสมอ (ok หรือ error) เพื่อให้ฝั่งที่เรียกแยกสำเร็จ/ผิดพลาดได้ง่าย

รูปแบบ response

{
  "status": "ok",
  "data": { ... }
}

{
  "status": "error",
  "error": {
    "code": "not_found",
    "message": "Not found, or it isn't owned by your account.",
    "errorId": null
  }
}

• status — ok เมื่อสำเร็จ (ข้อมูลอยู่ใน data) หรือ error เมื่อผิดพลาด (รายละเอียดอยู่ใน error)
• error.code — รหัสคงที่สำหรับให้โปรแกรมเช็ก (ดูความหมายในตารางด้านล่าง)
• error.message — ข้อความอธิบายสำหรับคน
• error.errorId — รหัสอ้างอิงเฉพาะครั้ง (มีเฉพาะ error ฝั่งเซิร์ฟเวอร์ 500); ปกติเป็น null

ความหมายของแต่ละ code

errorId คืออะไร

เมื่อเกิดข้อผิดพลาดที่ไม่คาดคิดฝั่งเซิร์ฟเวอร์ (internal_error / HTTP 500) ระบบจะสร้าง errorId เฉพาะของครั้งนั้น แล้วส่งกลับมาใน response พร้อมบันทึกไว้ในระบบ log ของเซิร์ฟเวอร์ — เวลามีปัญหา ให้ แจ้งผู้ดูแลพร้อม errorId นี้ เพื่อให้ตามหา log ของเหตุการณ์นั้นได้ตรงตัว

รูปแบบ: E-yyyyMMddHHmmss-xxxxxx (เวลา + เลขสุ่ม) เช่น

{
  "status": "error",
  "error": {
    "code": "internal_error",
    "message": "An unexpected server error occurred. Please retry, or contact support with this errorId.",
    "errorId": "E-20260617143012-a1b2c3"
  }
}