API V1 Users method group

/api/v1/users/local/authenticate
POST

کاربر را با استفاده از اطلاعات ورود محلی (ایمیل + رمز عبور) احراز هویت می‌کند و یک نشست (session) در سرور ایجاد می‌کند. پس از ورود موفق، سرور متن OK را بازمی‌گرداند و کوکی‌های 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"
}

Request Example (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 است که نشست کاربر را برقرار می‌کند.

Notes

• توکن‌ها و کوکی‌ها را فقط در محل‌های امن ذخیره کنید (کوکی‌های HttpOnly/Secure، متغیرهای محیطی، vaultهای امنیتی).
• browserFingerprint باید برای مرورگر/دستگاه یکسان ثابت بماند.
• پس از ورود، از کوکی‌های صادر شده برای فراخوانی متدهای محافظت‌شده 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"
}

Request Example (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"
    }
  }
}

Notes

• پس از فراخوانی این متد، یک کد بازیابی رمز عبور به ایمیل مشخص‌شده ارسال می‌شود.
• این کد را نگه دارید — برای مرحله بعد با متد /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"
}

Request Example (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

Notes

• این متد فقط پس از فراخوانی /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"
}

Request Example (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

Notes

• این متد فقط برای به‌روزرسانی access_token استفاده می‌شود. refresh_token جدید صادر نمی‌شود.
• browserFingerprint باید با مقداری که هنگام ورود از طریق /api/v1/users/local/authenticate ارائه شده بود مطابقت داشته باشد.
• refresh_token را فقط در کوکی‌های امن (HttpOnly ،Secure) ذخیره و ارسال کنید.

اطلاعات حساب یک کاربر احراز هویت‌شده را برمی‌گرداند: شناسه، ایمیل و مجموعه‌ای از مجوزها.
این متد پس از ورود کاربر استفاده می‌شود تا بخش‌ها و عملیات قابل دسترس در رابط کاربری تعیین شوند.

URL

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

Authorization Required

بله — نیازمند یک کوکی نشست معتبر که توسط متد /api/v1/users/local/authenticate صادر شده باشد.

Headers

• Accept: application/json
• Cookie (مثلاً session_id=...)

Parameters

هیچ‌کدام

Request Example (cURL)

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

Response Example (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

Notes

• adminPermissionsScope جزئیات مجوزهای زیرسیستم‌ها (خواندن/به‌روزرسانی/پردازش و غیره) را مشخص می‌کند.
• اگر رابط کاربری نیازی به حقوق مدیریتی نداشته باشد، فقط فیلدهای 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

نیازی نیست (بدنه خالی ارسال می‌شود).

Request Example (cURL)

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

Response Example (201)

OK

Responses

Notes

• این متد فقط نشست فعلی را خاتمه می‌دهد. اگر کاربر روی چند دستگاه وارد شده باشد، نشست دستگاه‌های دیگر فعال می‌ماند.
• پس از فراخوانی این متد، کاربر باید دوباره احراز هویت کند تا بتواند به متدهای خصوصی دسترسی داشته باشد.
• اگر کوکی یا توکن پیش از فراخوانی این متد منقضی شده باشد، سرور خطای 401 Unauthorized بازمی‌گرداند.

برای کاربر احراز هویت‌شده یک کلید API جدید ایجاد می‌کند.
این کلید شامل یک جفت publicKey و secretKey است که در هنگام کار با متدهای API v2 استفاده می‌شوند.
همچنین می‌توانید فهرستی از آدرس‌های IP مورد اعتماد (whitelist) و وضعیت فعال بودن کلید را مشخص کنید.

URL

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

Authorization Required

بله — این متد فقط برای کاربران واردشده در دسترس است.

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
}

Request Example (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
  }'

Response Example (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

Notes

• Public Key برای شناسایی کلاینت استفاده می‌شود.
• Secret Key فقط توسط کاربر نگهداری می‌شود و برای امضای درخواست‌ها در API v2 به کار می‌رود.
• توصیه می‌شود استفاده از کلید API را با IPهای مشخص‌شده (whiteListIp) محدود کنید تا امنیت افزایش یابد.
• اگر secretKey گم شود، قابل بازیابی نیست — باید یک کلید جدید ایجاد کنید.

فهرستی از تمام کلیدهای API ایجادشده توسط کاربر را بازمی‌گرداند.
این متد امکان مشاهده کلیدهای فعال و غیرفعال، پارامترهای آن‌ها (نام، فهرست سفید IP، وضعیت) و همچنین تاریخ ایجاد را فراهم می‌کند.
این متد برای مدیریت کلیدها در حساب کاربری استفاده می‌شود.

URL

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

Authorization Required

بله — کاربر باید احراز هویت شده باشد (کوکی نشست یا access token).

Parameters

هیچ‌کدام

Request Example (cURL)

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

Response Example (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

Notes

• publicKey در هدر درخواست‌های API v2 استفاده می‌شود.
• secretKey فقط هنگام ایجاد کلید از طریق /generate-api-key برگردانده می‌شود و در فهرست نمایش داده نمی‌شود.
• whiteListIp استفاده از کلید را فقط به IPهای مشخص‌شده محدود می‌کند.
• برای غیرفعال‌سازی یا حذف یک کلید، باید از متدهای مدیریت کلید (در صورت وجود) استفاده شود.

یک کلید API که قبلاً ایجاد شده است را حذف می‌کند.
پس از حذف، کلید نامعتبر شده و دیگر برای احراز هویت درخواست‌ها در API v2 قابل استفاده نخواهد بود.

URL

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

Authorization Required

بله — این متد فقط برای کاربران احراز هویت‌شده قابل دسترسی است.

Headers

• Accept: application/json
• Content-Type: application/json
• کوکی نشست (session_id=...)

Request Body (JSON)

{
  "apiId": 1
}

Request Example (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
  }'

Response Example (200)

true

Responses

Notes

• پس از حذف، کلید قابل بازیابی نیست. برای استفاده از API v2 باید کلید جدیدی تولید شود.
• این متد فقط شناسه کلید (apiId) را که از فهرست کلیدها (/api/v1/users/list-api-key) دریافت شده می‌پذیرد.
• حذف کلید در صورت افشای آن یا عدم نیاز به یکپارچه‌سازی توصیه می‌شود.

وضعیت فعلی KYC (شناخت مشتری) را برای کاربر احراز هویت‌شده بازمی‌گرداند.
این متد برای بررسی اینکه آیا کاربر تأیید هویت را با موفقیت گذرانده است یا خیر، و همچنین دریافت دلیل رد در صورت عدم موفقیت استفاده می‌شود.

URL

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

Authorization Required

بله — نیاز به یک نشست معتبر کاربر دارد.

Headers

• Accept: application/json
• کوکی نشست (access_token=...)

Parameters

هیچ

Request Example (cURL)

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

Example Response (200)

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

Possible status values

• PENDING — بررسی اسناد در حال انجام است.
• PASS — تأیید هویت با موفقیت انجام شده است.
• REJECTED — تأیید هویت رد شده است.

Responses

Notes

• این متد فقط وضعیت را بازمی‌گرداند — بارگذاری اسناد KYC توسط متدهای دیگر انجام می‌شود.
• فیلد rejectReason فقط زمانی وجود دارد که وضعیت REJECTED باشد یا تأیید رد شده باشد.
• مقادیر وضعیت می‌توانند برای نمایش پیشرفت در داشبورد کاربر استفاده شوند.