پرش به مطلب اصلی

بروزرسانی توکن ورود (Refresh Token)

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

(refresh_token) رفرش توکن یک توکن بلندمدت است که پس از منقضی شدن (token) توکن دسترسی، امکان دریافت توکن جدید را بدون نیاز به ورود مجدد فراهم می‌کند. این مکانیزم امنیت را افزایش داده و تجربه کاربری بهتری ارائه می‌دهد.

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

  • آدرس: /api/v3/auth/refresh-token
  • متد: POST
  • نوع محتوا: application/json
  • احراز هویت: نیازمند token

احراز هویت​

  • این درخواست نیاز به یک token دارد.
  • همچنین، مقدار Refresh Token باید در بدنه درخواست ارسال شود.

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

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

فیلدنوع دادهضروریتوضیحات
refresh_tokenstringبلهرفرش توکن که از ورود قبلی دریافت شده است

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

curl --location 'https://corporate.snapp.site/api/v3/auth/refresh-token' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: <your_authorization_token>' \
--data-raw '{
    "refresh_token": "<your_refresh_token>"
}'

پاسخ موفق​

{
  "data": {
    "token": "new_access_token",
    "refresh_token": "new_refresh_token",
    "need_reset": false,
    "need_two_factor_authenticate": false
  }
}
فیلدنوع دادهتوضیحات
tokenstringتوکن جدید احراز هویت
refresh_tokenstringتوکن نوسازی جدید
need_resetbooleanاگر true باشد، کاربر باید رمز عبور خود را تغییر دهد
need_two_factor_authenticatebooleanاگر true باشد، کاربر نیاز به احراز هویت دو مرحله‌ای دارد

خطاها​

کد وضعیتتوضیحات
500خطای داخلی سرور

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

  • توکن جدیدی که دریافت می‌کنید باید برای درخواست‌های آینده استفاده شود.
  • مقدار refresh_token نیز باید ذخیره شود تا در درخواست‌های بعدی بتوان از آن استفاده کرد.
  • در صورتی که توکن منقضی شده باشد، ممکن است نیاز به ورود مجدد داشته باشید.