مستندات Front-End صرافی رمزارز
Front-End Crypto Exchange Docs
نسخه 1.0.0 - 05/17/2021
فهرست مطالب
1. مقدمه
تمام مواردی که در مستندات ذکر شده است مربوط به راه اندازی Webapp یوآیدی میباشد.
2. روند احراز هویت در وب اپلیکیشن یوآیدی
همانطور که میدانید یوآیدی یک سیستم احراز هویت آنلاین میباشد و اطلاعات دریافتی شما از این سرویس توسط شخص کاربر ارایه شده است که صحت این اطلاعات و عواقب آن برعهده ی کاربر میباشد.
برای استفاده از وب اپلیکیشن لازم است پارامترهای مورد نیاز را از طریق URL به وب اپلیکیشن یوآیدی، هنگام اجرا کردن به آن انتقال دهید.
3. پیاده سازی لینک وب اپلیکیشن
برای استفاده از UID SDK لینک وب اپلیکیشن را با پارامترهای مشخص در اپلیکیشن خود پیاده سازی کنید.
3.1. ایجاد URL
https://cloud.uid.ir/crypto/?requestBusinessId=request_business_id&metaData=client_metaData
3.2. پارامترها
Field | Type | Description |
request_business_id | string | شناسه ای که توسط uid در اختیار بیزینس قرار داده می شود |
uidUrl | string | لینک اجرا کردن وب اپلیکیشن |
client_metaData | string | مقداری که توسط کسب و کار وارد می شود و در صورت نیاز می تواند خالی باشد |
4. ارسال وضعیت به وب سایت پذیرنده
برای بررسی نتیجه احراز هویت در اپ خود میتوانید وضعیت ها را در جدول زیر مشاهده کنید.
4.1. نمونه لینک برگشت به وب سایت پذیرنده
https://redirectUrl/?clientToken=client token&status=Value
4.2. وضعیت کدها
Result Code | Value | Description |
SUCCESS | 1 | احرازهویت با موفقیت به پایان رسید |
RESULT_CAMERA_NOT_SUPPORTED | 2 | دوربین پشتیبانی نمیشود |
RESULT_PERMISSIONS_NOT_GRANTED | 3 | دسترسی دوربین به SDK داده نشد |
RESULT_UNKNOWN_ERROR | 4 | خطای ناشناخته |
RESULT_INVALID_PARAMETERS | 5 | ورودیهای SDk نامعتبر است |
RESULT_SABTE_AHVAAL_UNAVAILABLE | 6 | ثبت احوال در دسترس نیست |
RESULT_ALREADY_APPROVED | 7 | کاربر قبلا فرایند را طی کرده است |
RESULT_MAX_TRY_EXCEEDED | 8 | درخواست بیش از حد مجاز |
RESULT_SIGNATURE | 9 | کاربر در مرحلهی تصویر امضا، فرایند را لغو کرده |
RESULT_LIVENESS | 10 | در مرحلهی ویدیوی سلفی، فرایند ناموفق به پایان رسید |
RESULT_FACE_MATCHING | 11 | عدم تطابق اطلاعات کاربر و ثبت احوال |
4.3. پارامترها
Field | Type | Description |
redirectUrl | string | لینک برگشت به سایت پذیرنده |
client token | string | شناسه ای که توسط یوآیدی در اختیار بیزینس قرار داده می شود، در صورتی که مقدار نداشته باشد، یعنی احراز هویت کامل نشده، و درصورتی که مقدار داشته باشد، یعنی مراحل با موفقیت به اتمام رسیده است. |