آماده‌سازی و احراز هویت

پیش‌نیاز: وایت‌لیست بودن IP + داشتن Username و Password | خروجی: دریافت access_token و refresh_token

روش‌های لاگین

دو روش برای لاگین وجود دارد:

روش اول : لاگین با پسورد

در این روش کانساینر می‌تواند بدون نیاز به دریافت رمز یکبار مصرف (OTP) و تنها با استفاده از نام کاربری و رمز عبور ثابت خود، مستقیماً توکن‌های دسترسی را دریافت کند.

ساختار درخواست (Request Body):

{
  "username": "string",
  "password": "string"
}

جدول پارامترهای ورودی (Request)

ساختار پاسخ موفق (Response Body - HTTP 200):

{
  "status_code": 200,
  "data": {
    "access_token": "string",
    "refresh_token": "string"
  }
}

جدول پارامترهای خروجی (Response)

روش دوم : لاگین با OTP

مرحله اول : دریافت OTP

در محیط پروداکشن ابتدا OTP بگیرید:

این API برای شروع فرآیند ورود استفاده می‌شود و یک کد تأیید یکبار مصرف به شماره همراه ثبت‌شده ارسال می‌کند.

ساختار درخواست (Request Body):

{
  "phone_number": "string"
}

جدول پارامترهای ورودی (Request)

ساختار پاسخ موفق (Response Body - HTTP 200):

{
  "status_code": 200,
  "data": {
    "ttl": 120
  }
}

جدول پارامترهای خروجی (Response)

مرحله دوم : ورود به سیستم و دریافت توکن (Login)

با ارسال شماره همراه و کد یکبار مصرف دریافتی در این مرحله، توکن‌های دسترسی صادر می‌شوند.

ساختار درخواست (Request Body):

{
  "username": "string",
  "otp_code": "string"
}

جدول پارامترهای ورودی (Request)

ساختار پاسخ موفق (Response Body - HTTP 200):

{
  "status_code": 200,
  "data": {
    "access_token": "string",
    "refresh_token": "string"
  }
}

جدول پارامترهای خروجی (Response)