API V1 Users method group

/api/v1/users/local/authenticate
POST

ยืนยันตัวตนผู้ใช้ด้วยข้อมูลเข้าสู่ระบบแบบภายใน (อีเมล + รหัสผ่าน) และสร้างเซสชันบนเซิร์ฟเวอร์
เมื่อเข้าสู่ระบบสำเร็จ เซิร์ฟเวอร์จะส่งข้อความ OK กลับมาและตั้งค่า cookies (session_id, access_token, refresh_token)
ซึ่งจะถูกใช้สำหรับคำขอที่ต้องมีการยืนยันตัวตนในภายหลัง

URL


https://quickex.io/api/v1/users/local/authenticate


Authorization Required

ไม่ต้องใช้ (การเข้าสู่ระบบสาธารณะด้วยข้อมูลภายใน)

Headers

• Accept: application/json
• Content-Type: application/json

Request Body (JSON)

{
  "browserFingerprint": "1231231231231231212312312",
  "email": "test@test.com",
  "password": "testtest"
}

ตัวอย่างคำขอ (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/local/authenticate' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "browserFingerprint": "1231231231231231212312312",
    "email": "test@test.com",
    "password": "testtest"
  }'

การตอบกลับ (Responses)

การตอบกลับที่สำเร็จจะมีส่วนหัว Set-Cookie และ session-id
ซึ่งใช้สำหรับสร้างเซสชันของผู้ใช้

หมายเหตุ

• ควรเก็บ token และ cookies ไว้ในที่ที่ปลอดภัย (HttpOnly/Secure cookies, environment variables, secret vaults)
• browserFingerprint ต้องคงเดิมสำหรับอุปกรณ์/เบราว์เซอร์เดียวกัน
• หลังเข้าสู่ระบบ ให้ใช้ cookies ที่ได้รับในการเรียกใช้ API v1 ที่ต้องมีสิทธิ์เข้าถึง

เริ่มกระบวนการรีเซ็ตรหัสผ่าน ระบบจะส่งรหัสสำหรับกู้คืนรหัสผ่านไปยังอีเมลที่ระบุ
รหัสนี้ต้องถูกเก็บไว้เพื่อนำไปใช้ในขั้นตอนถัดไปกับเมธอด /api/v1/users/local/reset-password

URL


https://quickex.io/api/v1/users/local/request-password-reset


Authorization Required

ไม่ต้องใช้ (คำขอรีเซ็ตรหัสผ่านสาธารณะ)

Headers

• Accept: application/json
• Content-Type: application/json

Request Body (JSON)

{
  "email": "user@example.com"
}

ตัวอย่างคำขอ (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/local/request-password-reset' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com"
  }'

การตอบกลับ (Responses)

{
  "status": "ERR_VALIDATION",
  "message": "Validation Exception",
  "data": {
    "email": {
      "isEmail": "email must be an email"
    }
  }
}

หมายเหตุ

• หลังจากเรียกเมธอดนี้ อีเมลที่กำหนดจะได้รับรหัสกู้คืนรหัสผ่าน
• ต้องเก็บรหัสนี้ไว้ — ใช้ในขั้นตอนถัดไปกับ /api/v1/users/local/reset-password
• หากอีเมลไม่มีอยู่หรือไม่ถูกต้อง เซิร์ฟเวอร์จะส่งข้อผิดพลาด 400

เสร็จสิ้นกระบวนการรีเซ็ตรหัสผ่าน ผู้ใช้ต้องระบุรหัสกู้คืนที่ได้รับทางอีเมลจากการเรียกใช้
/api/v1/users/local/request-password-reset พร้อมทั้งรหัสผ่านใหม่
หากสำเร็จ รหัสผ่านจะถูกอัปเดตและผู้ใช้สามารถเข้าสู่ระบบด้วยข้อมูลใหม่ได้

URL


https://quickex.io/api/v1/users/local/reset-password


Authorization Required

ไม่ต้องใช้ (ใช้รหัสกู้คืน)

Headers

• Accept: application/json
• Content-Type: application/json

Request Body (JSON)

{
  "resetCode": "1231231231231231212312312",
  "password": "testtest",
  "email": "test@example.com"
}

ตัวอย่างคำขอ (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/local/reset-password' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "resetCode": "1231231231231231212312312",
    "password": "testtest",
    "email": "test@example.com"
  }'

การตอบกลับ (Responses)

หมายเหตุ

• เมธอดนี้ใช้ได้เฉพาะหลังจากเรียก /api/v1/users/local/request-password-reset เท่านั้น
• รหัสกู้คืนมีอายุจำกัด
• หลังจากรีเซ็ตรหัสผ่านสำเร็จ ให้เข้าสู่ระบบด้วยข้อมูลใหม่ผ่าน /api/v1/users/local/authenticate

รีเฟรช access_token โดยใช้ refresh_token
เมธอดนี้ใช้เมื่อ access_token ปัจจุบันหมดอายุ
ระบบจะส่ง access_token ใหม่กลับมา ซึ่งต้องใช้สำหรับคำขอที่ต้องได้รับการป้องกันในครั้งถัดไป

URL


https://quickex.io/api/v1/users/authentication/refresh


Authorization Required

จำเป็น (ต้องมี refresh_token ที่ถูกต้องในคุกกี้)

Headers

• Accept: application/json
• Content-Type: application/json
• Cookie: refresh_token={REFRESH_TOKEN}

Request Body (JSON)

{
  "browserFingerprint": "1231231231231231212312312"
}

ตัวอย่างคำขอ (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/authentication/refresh' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --cookie "refresh_token=YOUR_REFRESH_TOKEN" \
  -d '{
    "browserFingerprint": "1231231231231231212312312"
  }'

การตอบกลับ (Responses)

หมายเหตุ

• เมธอดนี้ใช้เฉพาะเพื่อรีเฟรช access_token เท่านั้น จะไม่ออก refresh_token ใหม่
• browserFingerprint ต้องตรงกับค่าที่ใช้ระหว่างเข้าสู่ระบบผ่าน /api/v1/users/local/authenticate
• ควรเก็บและส่ง refresh_token ในคุกกี้ที่ปลอดภัยเท่านั้น (HttpOnly, Secure)

ส่งคืนข้อมูลบัญชีของผู้ใช้ที่ผ่านการยืนยันตัวตน: ID, อีเมล และชุดสิทธิ์การเข้าถึง
เมธอดนี้ใช้โดยไคลเอนต์หลังจากเข้าสู่ระบบเพื่อกำหนดว่าสามารถเข้าถึงส่วนใด/ทำการกระทำใดได้บ้างในอินเทอร์เฟซ

URL


https://quickex.io/api/v1/users/account-data


Authorization Required

ใช่ — ต้องมีคุกกี้เซสชันที่ถูกต้อง ซึ่งออกโดยเมธอด /api/v1/users/local/authenticate

Headers

• Accept: application/json
• Cookie (เช่น session_id=...)

Parameters

ไม่มี

ตัวอย่างคำขอ (cURL)

curl -X GET \
  'https://quickex.io/api/v1/users/account-data' \
  -H 'Accept: application/json' \
  --cookie "session_id=YOUR_SESSION_ID"

ตัวอย่างการตอบกลับ (200)

{
  "userId": 42,
  "email": "user@example.com",
  "permissions": "USER",
  "adminPermissionsScope": {
    "ORDERS": { "READ": true, "CONFIGURE": false, "PROCESS": true, "CREATE_LARGE_ADDITIONAL_WITHDRAWALS": false, "ENABLE_MANUAL_PROCESSING": false },
    "INSTRUMENTS": { "READ": true, "UPDATE": false },
    "PAIRS": { "READ": true, "UPDATE": false },
    "BESTCHANGE": { "READ": true, "UPDATE": false },
    "USERS": { "READ": true, "UPDATE": false },
    "API_KEYS": { "READ": true, "UPDATE": false },
    "STATS": { "READ": true },
    "AFFILIATES": { "READ": true, "UPDATE": false },
    "PLATFORM_FEE_COLLECTION": { "READ": true, "UPDATE": false },
    "TRANSLATION": { "READ": true, "UPDATE": false }
  }
}

การตอบกลับ (Responses)

หมายเหตุ

• adminPermissionsScope แสดงสิทธิ์ของแต่ละระบบย่อย (อ่าน/อัปเดต/ประมวลผล ฯลฯ)
• ถ้าในฝั่ง Frontend ไม่ต้องใช้สิทธิ์ระดับผู้ดูแล สามารถใช้เฉพาะ userId, email และ permissions ได้
• หากต้องการรีเฟรชเซสชัน ให้ใช้เมธอด /api/v1/users/authentication/refresh (ถ้าระบบของคุณรองรับ)

ยุติเซสชันผู้ใช้ปัจจุบัน
ใช้สำหรับออกจากระบบและทำให้โทเค็นการยืนยันตัวตน (หรือลูกกี้) ที่ใช้งานอยู่หมดอายุ

URL


https://quickex.io/api/v1/users/authentication/logout


Authorization Required

ใช่ — ผู้ใช้ต้องผ่านการยืนยันตัวตนก่อน

Headers

• Accept: application/json

Request Body

ไม่จำเป็น (ส่งบอดี้ว่าง)

ตัวอย่างคำขอ (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/authentication/logout' \
  -H 'Accept: application/json' \
  --cookie "session_id=YOUR_SESSION_ID" \
  -d ''

ตัวอย่างการตอบกลับ (201)

OK

การตอบกลับ (Responses)

หมายเหตุ

• เมธอดนี้จะยุติเฉพาะเซสชันปัจจุบันเท่านั้น หากผู้ใช้ล็อกอินหลายอุปกรณ์ เซสชันบนอุปกรณ์อื่นจะยังคงอยู่
• หลังจากเรียกเมธอดนี้ ผู้ใช้ต้องเข้าสู่ระบบใหม่เพื่อเข้าถึงเมธอดส่วนตัว
• หากคุกกี้หรือโทเค็นหมดอายุก่อนทำการเรียกเมธอดนี้ เซิร์ฟเวอร์จะส่งกลับ 401 Unauthorized

สร้างคีย์ API ใหม่สำหรับผู้ใช้ที่ผ่านการยืนยันตัวตน
คีย์ประกอบด้วยคู่ publicKey และ secretKey ซึ่งใช้สำหรับทำงานกับเมธอดใน API v2
นอกจากนี้ยังสามารถระบุรายการ IP ที่เชื่อถือได้ (whitelist) และสถานะการใช้งานของคีย์ได้ด้วย

URL


https://quickex.io/api/v1/users/generate-api-key


ต้องมีการยืนยันตัวตน

ใช่ — เมธอดนี้ใช้ได้เฉพาะผู้ใช้ที่เข้าสู่ระบบแล้วเท่านั้น

Headers

• Accept: application/json
• Content-Type: application/json
• Session Cookie (session_id=...)

Request Body (JSON)

{
  "name": "Api name / App name",
  "whiteListIp": [
    "127.0.0.1",
    "127.0.0.2"
  ],
  "isActive": true
}

ตัวอย่างคำขอ (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/generate-api-key' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --cookie "session_id=YOUR_SESSION_ID" \
  -d '{
    "name": "Api name / App name",
    "whiteListIp": ["127.0.0.1", "127.0.0.2"],
    "isActive": true
  }'

ตัวอย่างการตอบกลับ (200)

{
  "apiId": 1,
  "name": "Api name / App name",
  "publicKey": "pk_123456789",
  "secretKey": "sk_987654321",
  "whiteListIp": ["127.0.0.1","127.0.0.2"],
  "isActive": true,
  "createdAt": "2025-08-26 12:16:20"
}

การตอบกลับ (Responses)

หมายเหตุ

• Public Key ใช้สำหรับระบุตัวตนของไคลเอนต์
• Secret Key เก็บไว้เฉพาะฝั่งผู้ใช้ และใช้สำหรับเซ็นคำขอใน API v2
• แนะนำให้จำกัดการใช้งานคีย์ตาม IP (whiteListIp) เพื่อเพิ่มความปลอดภัย
• หาก secretKey สูญหาย จะไม่สามารถกู้คืนได้ — ต้องสร้างคีย์ใหม่

ส่งคืนรายการคีย์ API ทั้งหมดที่ผู้ใช้สร้างไว้
เมธอดนี้ช่วยให้ดูคีย์ที่ใช้งานอยู่และที่ไม่ใช้งาน พร้อมข้อมูลพารามิเตอร์ (ชื่อ, รายการ IP ที่อนุญาต, สถานะ) รวมถึงวันที่สร้าง
ใช้สำหรับจัดการคีย์ในบัญชีผู้ใช้

URL


https://quickex.io/api/v1/users/list-api-key


ต้องมีการยืนยันตัวตน

ใช่ — ผู้ใช้ต้องเข้าสู่ระบบ (session cookie หรือ access token)

Parameters

ไม่มี

ตัวอย่างคำขอ (cURL)

curl -X GET \
  'https://quickex.io/api/v1/users/list-api-key' \
  -H 'Accept: application/json' \
  --cookie "session_id=YOUR_SESSION_ID"

ตัวอย่างการตอบกลับ (200)

[
  {
    "apiId": 1,
    "name": "Api name / App name",
    "publicKey": "pk_123456789",
    "whiteListIp": [
      "127.0.0.1",
      "127.0.0.2"
    ],
    "isActive": true,
    "createdAt": "2025-08-26 12:16:20"
  }
]

การตอบกลับ (Responses)

หมายเหตุ

• publicKey ใช้ในส่วน headers ของ API v2
• secretKey จะถูกส่งให้เฉพาะตอนสร้างคีย์ผ่าน /generate-api-key เท่านั้น และจะไม่แสดงในรายการนี้
• whiteListIp จำกัดการใช้งานคีย์เฉพาะ IP ที่ระบุไว้
• หากต้องการปิดใช้งานหรือลบคีย์ ต้องใช้เมธอดจัดการ API key อื่น ๆ (ถ้ามีให้ใช้งาน)

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

URL


https://quickex.io/api/v1/users/delete-api-key


ต้องมีการยืนยันตัวตน

ใช่ — เมธอดนี้สามารถใช้ได้เฉพาะผู้ใช้ที่เข้าสู่ระบบแล้วเท่านั้น

Headers

• Accept: application/json
• Content-Type: application/json
• Session Cookie (session_id=...)

Request Body (JSON)

{
  "apiId": 1
}

ตัวอย่างคำขอ (cURL)

curl -X POST \
  'https://quickex.io/api/v1/users/delete-api-key' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --cookie "session_id=YOUR_SESSION_ID" \
  -d '{
    "apiId": 1
  }'

ตัวอย่างคำตอบ (200)

true

การตอบกลับ (Responses)

หมายเหตุ

• หลังจากลบแล้ว คีย์จะไม่สามารถกู้คืนได้ หากต้องการใช้ API v2 จะต้องสร้างคีย์ใหม่
• เมธอดนี้ต้องใช้ apiId ที่ได้รับจากรายการคีย์ (/api/v1/users/list-api-key) เท่านั้น
• ควรลบคีย์หากสงสัยว่ามีการรั่วไหลหรือเมื่อไม่ต้องการใช้งานคีย์นั้นแล้ว

ส่งคืนสถานะ KYC (Know Your Customer) ปัจจุบันของผู้ใช้ที่ผ่านการยืนยันตัวตน
เมธอดนี้ใช้เพื่อตรวจสอบว่าผู้ใช้ผ่านการยืนยันตัวตนแล้วหรือไม่ และใช้สำหรับดูสาเหตุการปฏิเสธหากการตรวจสอบไม่สำเร็จ

URL


https://quickex.io/api/v1/users/kyc/status


ต้องมีการยืนยันตัวตน

ใช่ — ต้องมีเซสชันผู้ใช้ที่ถูกต้อง

Headers

• Accept: application/json
• Session cookie (access_token=...)

Parameters

ไม่มี

ตัวอย่างคำขอ (cURL)

curl -X GET \
  'https://quickex.io/api/v1/users/kyc/status' \
  -H 'Accept: application/json' \
  --cookie "access_token=YOUR_TOKEN"

ตัวอย่างการตอบกลับ (200)

{
  "status": "PASS",
  "rejectReason": "ID_INFO_INVALID"
}

ค่าที่เป็นไปได้ของ status

• PENDING — อยู่ระหว่างตรวจสอบเอกสาร
• PASS — ผ่านการตรวจสอบแล้ว
• REJECTED — การตรวจสอบถูกปฏิเสธ

การตอบกลับ (Responses)

หมายเหตุ

• เมธอดนี้ส่งคืนเฉพาะสถานะเท่านั้น — การอัปโหลดเอกสาร KYC จะถูกจัดการโดยเมธอดอื่น
• ฟิลด์ rejectReason จะแสดงเฉพาะเมื่อสถานะเป็น REJECTED หรือการตรวจสอบถูกปฏิเสธ
• สถานะสามารถใช้แสดงความคืบหน้าในแดชบอร์ดของผู้ใช้