ورود به حساب کاربری (Login)

برای ورود اپراتورها و مدیران به سیستم استفاده می‌شود. پس از ورود موفق، یک توکن دسترسی و یک رفرش توکن در اختیار کاربر قرار می‌گیرد.

نکته مهم: برای استفاده از API لاگین، نیاز است تا شرط کپچا برای پنل شما غیرفعال شود. لطفاً درخواست غیرفعال‌سازی را به آدرس ایمیل panel@snapp.cab همراه با ارسال نام کاربری (ایمیل ثبت‌نامی) ارسال کنید.

---

اطلاعات عمومی

• آدرس: /api/v3/auth/login
• متد: POST
• نوع محتوا: application/json

---

پارامترهای درخواست

درخواست باید شامل یک شیء JSON با فیلدهای زیر باشد:

فیلد	نوع داده	ضروری	توضیحات
operator	boolean	خیر	مشخص می‌کند که کاربر یک اپراتور است یا نه (پیش‌فرض: false)
username	string	بله	نام کاربری فردی که قصد ورود دارد
password	string	بله	رمز عبور کاربر
captcha_refid	string	خیر	شناسه مرجع کپچا (در صورت نیاز)
captcha_type	string	بله	نوع کپچا مورد استفاده (مثلاً "numeric")

---

نمونه درخواست

curl --location 'https://corporate.snapp.site/api/v3/auth/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operator": false,
    "username": "username",
    "password": "password",
    "captcha_refid": "",
    "captcha_type": "numeric"
}'

---

پاسخ موفق

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

{
  "token": "token",
  "refresh_token": "token",
  "need_reset": false,
  "need_two_factor_authenticate": false
}

فیلد	نوع داده	توضیحات
token	string	توکن احراز هویت برای استفاده در درخواست‌های بعدی
refresh_token	string	توکن نوسازی که برای دریافت توکن جدید استفاده می‌شود
need_reset	boolean	اگر true باشد، کاربر نیاز به تغییر رمز عبور دارد
need_two_factor_authenticate	boolean	اگر true باشد، کاربر نیاز به احراز هویت دو مرحله‌ای دارد

---

توضیحات تکمیلی

• در صورتی که need_reset مقدار true داشته باشد، کاربر باید قبل از ادامه، رمز عبور خود را تغییر دهد.
• در صورتی که need_two_factor_authenticate مقدار true داشته باشد، کاربر باید احراز هویت دو مرحله‌ای را تکمیل کند.

---