توکن

تمدید توکن

<!--seo-open-->

قبل از انقضای access token با ارسال refresh token می‌توانید توکن جدید دریافت کنید؛ برای توکن CODE و CLIENT-CREDENTIAL. احراز هویت با Basic (client_id:client_secret).

<!--/seo-open-->

قبل از منقضی شدن توکن با ارسال رفرش توکن، می‌توانید توکن جدید دریافت کنید.

آدرس API:

POST /dev/v2/oauth2/token

Grant type: refresh_token

Headers

مقادیر زیر باید در هدر قرار بگیرد:

Content-Type: application/json
Authorization: Basic {AuthenticationString}

مقدار AuthenticationString باید برابر Base64 از اطلاعات برنامه شما به صورت YOURCLIENTID:YOURCLIENTSECRET باشد. برای مثال اگر شناسه برنامه شما برابر firstapp باشد و رمز برنامه شما که در قسمت جزییات برنامه در کنسول قابل مشاهده است برابر 6932dddb927b76e54997 باشد، شما باید Base64 مقدار firstapp:6932dddb927b76e54997 را تولید کنید. در این صورت مقدار این هدر باید برابر مقدار زیر قرار گیرد:

Basic Zmlyc3RhcHA6NjkzMmRkZGI5MjdiNzZlNTQ5OTc=

Notes

فرستادن تمام پارامترهای Body الزامی است.

برای توکن‌های تایپ CODE اگر از نوع احراز هویت با OTP و از طریق SMS باشد، فرستادن auth_type اجباری است و نیازی به فرستادن bank نیست. در غیر این صورت فرستادن bank اجباری و نیازی به فرستادن auth_type نیست.

در صورت رفرش توکن بانک کشاورزی، فرستادن فیلدهای bank و deposit الزامی است.

بانککد
آینده062
کشاورزی016
پارسیان054
پاسارگاد057
خاورمیانه078

نکته: با توجه به لزوم رعایت دقیق پروتکل‌های OAuth 2.0، پس از دریافت AccessToken و RefreshToken جدید، حتماً از رفرش توکن جدید استفاده گردد.

post/dev/v2/oauth2/token/refresh

Request

  • Base URL: https://api.finnotech.ir
  • URL: https://api.finnotech.ir/dev/v2/oauth2/token/refresh
  • Auth: HTTP basic

Request body

grant_type'refresh_token' required

باید برابر refresh_token باشد

token_type'CODE' | 'CLIENT-CREDENTIAL' required

نوع توکن (CLIENT-CREDENTIAL یا CODE)

refresh_tokenstring required

رفرش توکن

auth_type'SMS'

در صورت رفرش توکن نوع SMS، ارسال این فیلد با مقدار SMS الزامی است

bankstring

کد بانک مقصد. برای توکن CODE غیر SMS و برای توکن کشاورزی الزامی است. برای توکن SMS یا CLIENT_CREDENTIAL بدون حساب نیازی به ارسال نیست.

depositstring

شماره حساب (برای رفرش توکن بانک کشاورزی الزامی است)

Example request

{
  "bank": "062"
}

Response

توکن با موفقیت تمدید شد

status'DONE' | 'FAILED'

Example response

{
  "result": {
    "type": "CODE"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.