docs
API แผงควบคุม

การเข้าสู่ระบบและเซสชัน

Markdown

เมธอด ฟิลด์คำขอ และคำตอบ

คู่มือฉบับเต็ม

ส่วนนี้มี 14 เมธอด เปิดเมธอดเพื่อดูเงื่อนไขการเข้าถึง ฟิลด์คำขอ และคำตอบ

เมธอดและพาธคำอธิบายการเข้าถึง
POST /api/v1/auth/forgot-passwordคำขอรีเซ็ตรหัสผ่านไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/loginเข้าสู่ระบบด้วยอีเมลและรหัสผ่านไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/login/2faดำเนินการเข้าสู่ระบบด้วย TOTP ให้เสร็จสมบูรณ์ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/logoutออกจากระบบและเพิกถอน refresh tokenไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
GET /api/v1/auth/meผู้ใช้ปัจจุบัน ยอดคงเหลือ และขีดจำกัดโทเคนแดชบอร์ด
POST /api/v1/auth/passkey/login/beginเริ่มเข้าสู่ระบบด้วย passkeyไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/passkey/login/finishดำเนินการเข้าสู่ระบบด้วย passkey ให้เสร็จสมบูรณ์ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/refreshต่ออายุโทเคนไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/registerสมัครสมาชิกไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/reset-passwordรีเซ็ตรหัสผ่านไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/revoke-all-sessionsเพิกถอนเซสชันทั้งหมดโทเคนแดชบอร์ด
POST /api/v1/auth/send-verify-codeส่งรหัสยืนยันไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/validate-invitation-codeตรวจ⁠สอบคำเชิญไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/validate-promo-codeตรวจ⁠สอบรหัสโปรโมชันไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด
POST /api/v1/auth/forgot-password — คำขอรีเซ็ตรหัสผ่าน

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ขีดจำกัดอัตรา: 5 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/forgot-password

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
emailstringใช่required,email
turnstile_tokenstringไม่
เทมเพลตเนื้อหาคำขอ
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: ForgotPasswordRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: ForgotPasswordResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

POST /api/v1/auth/login — เข้าสู่ระบบด้วยอีเมลและรหัสผ่าน

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ระบบจะตรวจ⁠สอบว่าฟีเจอร์พร้อมใช้งานหรือไม่และตรวจ⁠สอบเงื่อนไขการเข้าถึงเพิ่มเติมขณะประมวลผลคำขอ

ขีดจำกัดอัตรา: 20 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/login

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
emailstringใช่required,email
passwordstringใช่required
turnstile_tokenstringไม่
เทมเพลตเนื้อหาคำขอ
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: LoginRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: TotpLoginResponse, User, AuthResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

หากคำตอบมีได้หลายรูปแบบ ฟิลด์ของแต่ละรูปแบบจะแสดงในสคีมาแยกกัน ไม่ควรรวมเป็นออบเจ็กต์เดียว

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

POST /api/v1/auth/login/2fa — ดำเนินการเข้าสู่ระบบด้วย TOTP ให้เสร็จสมบูรณ์

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ระบบจะตรวจ⁠สอบว่าฟีเจอร์พร้อมใช้งานหรือไม่และตรวจ⁠สอบเงื่อนไขการเข้าถึงเพิ่มเติมขณะประมวลผลคำขอ

ขีดจำกัดอัตรา: 20 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/login/2fa

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
temp_tokenstringใช่required
totp_codestringใช่required,len=6
เทมเพลตเนื้อหาคำขอ
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: Login2FARequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: User, AuthResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

หากคำตอบมีได้หลายรูปแบบ ฟิลด์ของแต่ละรูปแบบจะแสดงในสคีมาแยกกัน ไม่ควรรวมเป็นออบเจ็กต์เดียว

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

POST /api/v1/auth/logout — ออกจากระบบและเพิกถอน refresh token

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

POST/api/v1/auth/logout

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
refresh_tokenstringไม่; ไม่จำเป็น: เพิกถอนโทเคนสำหรับต่ออายุที่ระบุ
เทมเพลตเนื้อหาคำขอ
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: LogoutRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: LogoutResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

GET /api/v1/auth/me — ผู้ใช้ปัจจุบัน ยอดคงเหลือ และขีดจำกัด

การเข้าถึง: โทเคนแดชบอร์ด

GET/api/v1/auth/me
การอ่าน; ใช้ ID จากคำตอบก่อนหน้าของคุณ
curl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
  -H "Authorization: Bearer $TOKEN"

ไม่ต้องส่งเนื้อหาคำขอ ให้ส่งพารามิเตอร์ที่ระบุไว้ด้านบนใน URL

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: User, UserProfileResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}

ข้อควรทราบ: ข้อมูลส่วนบุคคลและออบเจ็กต์ทั้งหมดจำกัดขอบเขตตามตัวตนที่ระบุใน JWT

ข้อควรทราบ: ขีดจำกัดค่าใช้จ่ายของคีย์ (quota, quota_used) ส่งกลับในคำตอบเกี่ยวกับคีย์ ไม่ใช่ในโปรไฟล์ frozen_balance คือจำนวนเงินที่กันไว้ จึงไม่ใช่ยอดคงเหลือที่ใช้ได้

POST /api/v1/auth/passkey/login/begin — เริ่มเข้าสู่ระบบด้วย passkey

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ระบบจะตรวจ⁠สอบว่าฟีเจอร์พร้อมใช้งานหรือไม่และตรวจ⁠สอบเงื่อนไขการเข้าถึงเพิ่มเติมขณะประมวลผลคำขอ

ขีดจำกัดอัตรา: 20 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/passkey/login/begin

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
turnstile_tokenstringไม่
เทมเพลตเนื้อหาคำขอ
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: PasskeyBeginLoginRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: PasskeyOptionsResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
    "options": "PLACEHOLDER_OPTIONS (any)"
  }
}

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

ข้อควรทราบ: รับ credential จาก navigator.credentials และ session_token จาก begin เนื้อหาคำขอ Finish <=65536 ไบต์; การลงทะเบียนและการลบต้องใช้รหัสผ่าน

POST /api/v1/auth/passkey/login/finish — ดำเนินการเข้าสู่ระบบด้วย passkey ให้เสร็จสมบูรณ์

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ระบบจะตรวจ⁠สอบว่าฟีเจอร์พร้อมใช้งานหรือไม่และตรวจ⁠สอบเงื่อนไขการเข้าถึงเพิ่มเติมขณะประมวลผลคำขอ

ขีดจำกัดอัตรา: 20 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/passkey/login/finish

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
session_tokenstringใช่required
namestringไม่
credentialobjectใช่required
เทมเพลตเนื้อหาคำขอ
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: PasskeyFinishRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: User, AuthResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

หากคำตอบมีได้หลายรูปแบบ ฟิลด์ของแต่ละรูปแบบจะแสดงในสคีมาแยกกัน ไม่ควรรวมเป็นออบเจ็กต์เดียว

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

ข้อควรทราบ: รับ credential จาก navigator.credentials และ session_token จาก begin เนื้อหาคำขอ Finish <=65536 ไบต์; การลงทะเบียนและการลบต้องใช้รหัสผ่าน

POST /api/v1/auth/refresh — ต่ออายุโทเคน

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ระบบจะตรวจ⁠สอบว่าฟีเจอร์พร้อมใช้งานหรือไม่และตรวจ⁠สอบเงื่อนไขการเข้าถึงเพิ่มเติมขณะประมวลผลคำขอ

ขีดจำกัดอัตรา: 30 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/refresh

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
refresh_tokenstringใช่required
เทมเพลตเนื้อหาคำขอ
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: RefreshTokenRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: RefreshTokenResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "access_token": "PLACEHOLDER_ACCESS_TOKEN (string)",
    "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)",
    "expires_in": "PLACEHOLDER_EXPIRES_IN (integer)",
    "token_type": "PLACEHOLDER_TOKEN_TYPE (string)"
  }
}

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

POST /api/v1/auth/register — ลงทะเบียน

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ขีดจำกัดอัตรา: 5 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/register

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
emailstringใช่required,email
passwordstringใช่required,min=6
verify_codestringไม่
turnstile_tokenstringไม่
promo_codestringไม่; รหัสโปรโมชันสำหรับลงทะเบียน
invitation_codestringไม่; รหัสคำเชิญ
เทมเพลตเนื้อหาคำขอ
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "verify_code": "PLACEHOLDER_VERIFY_CODE (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)",
  "promo_code": "PLACEHOLDER_PROMO_CODE (string)",
  "invitation_code": "PLACEHOLDER_INVITATION_CODE (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: RegisterRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: User, AuthResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

หากคำตอบมีได้หลายรูปแบบ ฟิลด์ของแต่ละรูปแบบจะแสดงในสคีมาแยกกัน ไม่ควรรวมเป็นออบเจ็กต์เดียว

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

POST /api/v1/auth/reset-password — รีเซ็ตรหัสผ่าน

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ขีดจำกัดอัตรา: 10 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/reset-password

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
emailstringใช่required,email
tokenstringใช่required
new_passwordstringใช่required,min=6
เทมเพลตเนื้อหาคำขอ
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: ResetPasswordRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: ResetPasswordResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

POST /api/v1/auth/revoke-all-sessions — เพิกถอนเซสชันทั้งหมด

การเข้าถึง: โทเคนแดชบอร์ด

POST/api/v1/auth/revoke-all-sessions

ไม่ต้องส่งเนื้อหาคำขอ

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: RevokeAllSessionsResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

ข้อควรทราบ: ข้อมูลส่วนบุคคลและออบเจ็กต์ทั้งหมดจำกัดขอบเขตตามตัวตนที่ระบุใน JWT

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

POST /api/v1/auth/send-verify-code — ส่งรหัสยืนยัน

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ขีดจำกัดอัตรา: 5 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/send-verify-code

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
emailstringใช่required,email
turnstile_tokenstringไม่
เทมเพลตเนื้อหาคำขอ
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: SendVerifyCodeRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: SendVerifyCodeResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)",
    "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
  }
}

ข้อควรทราบ: การดำเนินการนี้เปลี่ยนสถานะหรือดำเนินขั้นตอนยืนยันสิทธิ์แบบใช้ครั้งเดียวต่อ ตัวอย่างอธิบายสัญญาการทำงานและไม่ได้ถูกเรียกใช้จริง

POST /api/v1/auth/validate-invitation-code — ตรวจ⁠สอบคำเชิญ

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ระบบจะตรวจ⁠สอบว่าฟีเจอร์พร้อมใช้งานหรือไม่และตรวจ⁠สอบเงื่อนไขการเข้าถึงเพิ่มเติมขณะประมวลผลคำขอ

ขีดจำกัดอัตรา: 10 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/validate-invitation-code

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
codestringใช่required
เทมเพลตเนื้อหาคำขอ
{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: ValidateInvitationCodeRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: ValidateInvitationCodeResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)"
  }
}

ลักษณะเฉพาะ: เมธอดนี้ตรวจ⁠สอบคำเชิญและไม่ใช้รหัส ตัวอย่างอธิบายสัญญา API และไม่ได้ถูกเรียกใช้งาน

POST /api/v1/auth/validate-promo-code — ตรวจ⁠สอบรหัสโปรโมชัน

การเข้าถึง: ไม่ต้องเข้าสู่ระบบ; ดูเงื่อนไขเพิ่มเติมที่เมธอด

ระบบจะตรวจ⁠สอบว่าฟีเจอร์พร้อมใช้งานหรือไม่และตรวจ⁠สอบเงื่อนไขการเข้าถึงเพิ่มเติมขณะประมวลผลคำขอ

ขีดจำกัดอัตรา: 10 คำขอต่อ 60 วินาทีจากที่อยู่เดียว

POST/api/v1/auth/validate-promo-code

ฟิลด์ JSON / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
codestringใช่required
เทมเพลตเนื้อหาคำขอ
{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: ValidatePromoCodeRequest

คำตอบ

คำตอบ JSON มี code, message และ data เนื้อหาของ data อธิบายไว้ในสคีมาด้านล่าง

สคีมาข้อมูลคำตอบ: ValidatePromoCodeResponse. ดูฟิลด์และชนิดข้อมูลได้ในหน้า “โครงสร้างข้อมูล”

สคีมาคำตอบ โดยค่าเป็นเพียงตัวอย่าง
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "bonus_amount": "PLACEHOLDER_BONUS_AMOUNT (number)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)",
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

ลักษณะเฉพาะ: เมธอดนี้ตรวจ⁠สอบรหัสโปรโมชันและไม่เพิ่มโบนัส ตัวอย่างอธิบายสัญญา API และไม่ได้ถูกเรียกใช้งาน

การเข้าสู่ระบบและเซสชัน · 2FA

POST /api/v1/auth/login → data

  • data.requires_2fa === true → TotpLoginResponse → data.temp_token → POST /api/v1/auth/login/2fa · {"temp_token": "…", "totp_code": "…"} → data.access_token
  • data.access_token → AuthResponse → Authorization: Bearer $TOKEN

totp_code: string, len = 6. temp_token ≠ access_token. User

ยังมีคำถามอยู่ใช่ไหม ส่ง Request ID และรายละเอียดมาให้เรา เราจะช่วยตรวจ⁠สอบติดต่อฝ่ายสนับสนุน