ข้ามไปยังเนื้อหาหลัก

ข้อกำหนดของ API

Success response​

ทุก endpoint ภายใต้ /api/v1/... จะห่อข้อมูลไว้ในรูปแบบ { "data": T }:

{
  "data": { ... }
}

ส่วน GET /api/health จะคืนค่าเป็น object ตรง ๆ โดยไม่มี wrapper

Error response​

{
  "code": "1002",
  "message": "Unauthorized."
}

Error codes​

CodeMeaning
1000คำขอไม่ถูกต้อง
1001ข้อผิดพลาดภายในเซิร์ฟเวอร์
1002ไม่ได้รับอนุญาต
2000ไม่พบ template
2002ไม่พบ subject
2003ไม่พบ system

HTTP status codes​

StatusMeaning
200สำเร็จ (GET)
201สร้างสำเร็จ (POST)
400คำขอไม่ถูกต้อง
401ไม่ได้รับอนุญาต
404ไม่พบข้อมูล
500เซิร์ฟเวอร์ผิดพลาด