Conventions

กติกากลางที่ใช้เหมือนกันทุก endpoint ของ member API — อ่านหน้านี้ครั้งเดียว แล้วหน้า endpoint จะเหลือแค่รายละเอียดเฉพาะเส้น

Base URL และเวอร์ชัน

  • BASE_URL แยกตาม environment — ได้จากทีม best-system
  • ทุกเส้นอยู่ใต้ prefix /api/v1 (URI versioning — เวอร์ชันปัจจุบันคือ v1)
text
https://api.example.com/api/v1/games/providers
└──────── BASE_URL ───────┘└─ prefix ─┘└─ endpoint ─┘

Response envelope

ทุก endpoint ตอบ JSON โครงเดียวกันเสมอ ทั้งสำเร็จและ error — parser ฝั่งคุณเขียนครั้งเดียวใช้ได้ทุกเส้น

json
{
  "success": true,
  "code": 0,
  "message": "สำเร็จ",
  "data": { "revoked": true },
  "request_uuid": "9f2b7d1e-4a83-4c1f-b2ce-6d5a0e8f3c21"
}
ฟิลด์ชนิดความหมาย
successbooleantrue เมื่อสำเร็จ (คู่กับ code = 0) · false เมื่อ error
codenumberBusinessCode — 0 = สำเร็จ, ค่าอื่นคือรหัสผลลัพธ์เชิงธุรกิจ (เลขชุดเดียวทั้งระบบ)
messagestringข้อความอ่านได้ของ code — ภาษาตาม x-lang (default th)
dataobject · array · nullpayload ของ endpoint · กรณี error เป็น null เสมอ
request_uuidstringid ของ request — echo จาก X-Request-Id ถ้าส่งมา ไม่งั้นระบบ generate ให้

Rate limit

ช่องทางขอบเขตเพดาน
External S2Sทั้ง key รวมทุกเส้น600 req/นาที
External S2Sกลุ่ม /auth/*120 req/นาที
Hostedต่อ IP รวมทุกเส้น120 req/นาที
Hostedกลุ่ม /auth/* ต่อ IP10 req/นาที