توکن

توکن پیامکی:مرحله ۱: درخواست احراز هویت

<!--seo-open-->

سرویس «مرحله ۱: درخواست احراز هویت» (KYC / SMS/OTP) در دسته توکن Authorization Code پیامکی (OAuth2 SMS) فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی پس از رضایت کاربر با رویکرد Authorization Code است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

<!--/seo-open-->

از این سرویس برای تولید توکن با رویکرد Authorization_Code_Type_SMS استفاده کنید (اشخاص حقیقی و حقوقی). سرویس‌هایی که از این نوع توکن استفاده می‌کنند نیاز به منابع سایر کاربران دارند و باید اجازه‌ی دسترسی از کاربر گرفته شود.

سرویس‌های وابسته:

  • مرحله ۲: تایید درخواست احراز هویت
  • مرحله ۳: درخواست توکن

اولین قدم برای استفاده از این سرویس‌ها درخواست احراز هویت از کاربر است؛ به این معنی که کاربر به برنامه‌ی شما اجازه فراخوانی سرویس‌ها را بدهد. به این منظور باید درخواست احراز هویت را به شماره موبایلی که این مجوز را صادر می‌کند بفرستید.

دانلود مستندات ریسپانس کدها — response-code-token-sms

GET /dev/v2/oauth2/authorize?client_id={client_id}&response_type=code&redirect_uri={redirect_uri}&scope={scope}&mobile={mobile}&state={state}&auth_type=SMS

Headers

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

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

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

Basic Zmlyc3RhcHA6NjkzMmRkZGI5MjdiNzZlNTQ5OTc=

مثال

https://api.finnotech.ir/dev/v2/oauth2/authorize?client_id=smokey&response_type=code&redirect_uri=https://localhost/&scope=credit:sms-advance-reliability:get&mobile=09300000000&state=15467287&auth_type=SMS

در صورتی که پارامترها به درستی مشخص شوند، پیامکی برای شماره موبایل درج‌شده ارسال خواهد شد. در صورت تمایل به اعطای دسترسی، کد OTP دریافتی در پیامک را در مرحله ۲ وارد کنید. همچنین trackId دریافتی در این مرحله برای مرحله بعد لازم است.

<div class="docs-notice" dir="rtl"> <h3>تذکر</h3> <p><strong>برای گرفتن توکن کشاورزی مقادیر زیر الزامی است:</strong></p> <p>nid: کد ملی صاحب امضا حساب معرفی شده به بانک</p> <p>deposit: حساب معرفی شده به بانک</p> <p>bank: کد بانک‌های فعال با توکن اس‌ام‌اسی — کشاورزی: 016</p> <p><strong>در صورت استفاده از سرویس انتقال وجه مقادیر زیر الزامی است:</strong></p> <p>limit: حداکثر مبلغ هر تراکنش به ریال</p> <p>count: حداکثر تعداد تراکنش ماهانه به ازای یک توکن</p> </div>
get/dev/v2/oauth2/authorize

Request

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

Query parameters

client_idstring required

شناسه ثبت‌شده برای کلاینت در سامانه فینوتک

redirect_uristring uri required

آدرس بازگشتی کلاینت؛ دامنه این آدرس باید با دامنه ثبت‌شده به ازای آدرس بازگشتی کلاینت در فینوتک برابر باشد. آدرسی که در این قسمت فرستاده می‌شود باید با آدرس بازگشتی ارسال‌شده در مرحله دریافت توکن برابر باشد.

scopestring required

اسکوپ (دسترسی)هایی که کاربر باید مجوز دسترسی به آن‌ها را بدهد، به صورت جدا‌شونده با کاما انگلیسی (comma separated). تنها اسکوپ‌هایی که تایپ توکن آن‌ها از نوع sms است در اینجا قابل استفاده‌اند. اسکوپ‌های با دسته‌بندی متفاوت نمی‌توانند باهم ارسال شوند.

response_type'code' required

نوع پاسخ که باید برابر code باشد

mobilestring required

شماره موبایلی که کد احراز هویت به منظور تایید دسترسی برای سرویس مورد نظر به آن ارسال خواهد شد

statestring

(اختیاری) این کد برای ردگیری درخواست توسط کلاینت استفاده می‌شود و در صورت ارسال به همراه کد به آدرس بازگشتی کلاینت برگردانده می‌شود

auth_type'SMS' required

نوع احراز هویت (sms)

Response

پیامک OTP ارسال شد

status'DONE' | 'FAILED'

Changes

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