مستندات سرویس PWA احراز هویت تصویری آنلاین

sAUTH PWA Documents

نسخه 1.0.0 - 02/11/2024

فهرست مطالب

بخش اول: فراخوانی PWA

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

۱. مقدمه

تمام مواردی که در مستندات ذکر شده است مربوط به راه اندازی PWA یوآیدی می‌باشد.

۲. روند احراز هویت در وب اپلیکیشن یوآیدی

همانطور که میدانید یوآیدی یک سیستم احراز هویت آنلاین می‌باشد و اطلاعات دریافتی شما از این سرویس توسط شخص کاربر ارائه شده است که صحت این اطلاعات و عواقب آن برعهده‌ی کاربر می‌باشد.

برای استفاده از وب اپلیکیشن لازم است پارامترهای مورد نیاز را از طریق URL به وب اپلیکیشن یوآیدی، هنگام اجرا کردن به آن انتقال دهید.

۳. فراخوانی PWA احراز هویت یوآیدی

برای استفاده از سرویس PWA یوآیدی پس از ورود و دریافتsessionId لینک وب اپلیکیشن را با پارامترهای مشخص در اپلیکیشن خود ایجاد کنید.

۱.۳. ورود پذیرنده

ابتدا با استفاده از id,Token (توسط یوآیدی در اختیار پذیرنده قرار داده می‌شود) وارد سیستم شوید و access_token دریافت نمایید.

				
					POST - https://api-bff.uid.ir/api/business/login


Content-Type: application/json;charset=UTF-8
{
  "businessId": <UID_BUSINESS_ID>,
  "businessToken": <UID_BUSINESS_TOKEN>
}

				
			

۲.۳. توضیح پارامترهای درخواستی

FieldTypeRequiredDescription
businessId
stringYES

شناسه کسب‌و‌کار یا BusinessID

(توسط یوآیدی در اختیار شما قرار می‌گیرد)

businessToken
stringYES

توکن کسب‌و‌کار یا BusinessTOKEN

(توسط یوآیدی در اختیار شما قرار می‌گیرد)

۳.۳. نمونه پاسخ دریافتی

				
					{
    "accessToken": <ACCESS_TOKEN>
}
				
			

۴.۳. تخصیص SESSION برای کاربر

با ارسال تاریخ تولد و کد ملی در Body و ارسال accessToken در Header برای یوزر sessionId دریافت کنید.

				
					POST - https://api-bff.uid.ir/api/simplified/get-session-id


x-api-key: <ACCESS_TOKEN>
Content-Type: application/json;charset=UTF-8
{
    "birthDate":"1372/11/02",
    "nationalId":"0123456789"
}
				
			

۵.۳. توضیح پارامترهای درخواستی

FieldType RequiredDescription
x-api-keystringYESaccessToken که در مرحله قبل دریاف شد
birthDate
string YESتاریخ تولد کاربر با فرمت: YYYY/MM/DD
nationalId
string YESکد ملی کاربر

۶.۳. نمونه پاسخ دریافتی

				
					{
    "sessionId": <SESSION_ID>,
    "error": null
}
				
			

بخش دوم: ایجاد URL

 

۱. مقدمه

تمامی وب‌ سرویس‌های توضیح داده شده در این مستندات به صورت RESTful هستند و طبق همین چهارچوب باید با آنها ارتباط برقرار کرد.

جهت رفع هرگونه مشکل و یا پرسش با پشتیبانی در تماس باشید.

۲. احراز هویت و ورود از طریق یوآیدی

آدرس زیر را با استفاده از پارامتر‌ها ایجاد و توسط کلاینت کاربر فراخوانی نمائید:‌

				
					https://bff.u-id.net//?business_id=<UID_BUSINESS_ID>&user_session_id=<UID_USER_SESSION_ID>&user_redirect_url=<USER_REDIRECT_URL
				
			

۱.۲.تعیین نتیجه احراز و فراخوانی کال‌بک پذیرنده توسط UID

کابر پس از ضبط ویدیو،با status به user_redirect_url که در پارامتر ورودی دریافت شده، ریدایرکت میشود و نتیجه احراز هویت به کالبک اعلام شده از سمت بیزینس بازگشت داده میشود

۲.۲. نمونه پاسخ دریافتی در کا‌ل‌بک

				
					{
   "sessionId":<SESSION_ID>,
   "finalAuthenticationResult":<FINAL_AUTHENTICATION_RESULT>,
   "finalAuthenticationResultReason":<FINAL_AUTHENTICATION_RESULT_REASON>
}
				
			

۳. نتایج سرویس

نتایج سرویس شامل دو بخش status که در لینک ریدایرکت شده به بیزینس، بازگشت داده میشود و نتیجه نهایی احراز هویت که در کال‌بک بازگشت داده میشود

۱.۳. جدول مقادیر Status احراز هویت

ResultValueDescription
SUCCESS۱احراز هویت با موفقیت به پایان رسید
RESULT_CAMERA_NOT_SUPPORTED۲دوربین پشتیبانی نمی‌شود
RESULT_PERMISSIONS_NOT_GRANTED۳دسترسی دوربین به PWA داده نشد
RESULT_UNKNOWN_ERROR۴خطای ناشناخته
RESULT_INVALID_PARAMETERS۵ورودی‌های PWA نامعتبر است
RESULT_SABTE_AHVAAL_UNAVAILABLE۶ثبت احوال در دسترس نیست
RESULT_ALREADY_APPROVED۷کاربر قبلا فرایند را طی کرده است
RESULT_MAX_TRY_EXCEEDED۸درخواست بیش از حد مجاز
RESULT_SIGNATURE۹کاربر در مرحله‌ی تصویر امضا، فرایند را لغو کرده
RESULT_LIVENESS۱۰در مرحله‌ی ویدیوی سلفی، فرایند ناموفق به پایان رسید
RESULT_FACE_MATCHING۱۱عدم تطابق اطلاعات کاربر و ثبت احوال

توجه: وضعیت‌های فوق که در پاسخ ارسال می‌شوند مربوط به «فرآیند احراز هویت» می‌باشند و نه نتیجه‌ی آن. نتیجه احراز هویت کاربر در کال‌بک ارسال میگردد.

۲.۳. توضیح پاسخ های دریافتی در کال‌بک

FieldTypeDescription
sessionIdstring

SessionId که یوزر با استفاده از آن در سامانه ویدیو ضبط کرده

finalAuthenticationResult string – ENUM

FINAL_AUTHENTICATION_RESULT_UNDEFINED
FINAL_AUTHENTICATION_RESULT_ACCEPTED
FINAL_AUTHENTICATION_RESULT_REJECTED

finalAuthenticationResultReason string – ENUMFINAL_AUTHENTICATION_RESULT_REASON_UNDEFINED
FINAL_AUTHENTICATION_RESULT_REASON_ACCEPT
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_FACE_NOT_MATCH_IMAGE_ID
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_VIDEO_NOT_LIVE
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_VIDEO_BAD_LIGHT
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_INCOMPATIBLE_HEJAB
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_INCOMPATIBLE_ANGLE_CAMERA
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_INCOMPATIBLE_BACKGROUND
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_INCOMPATIBLE_LOOK_CAMERA
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_VIDEO_BAD_QUALITY
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_PERSON_TOO_FAR_AWAY
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_MORE_THAN_ONE_PERSON
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_NO_PERSON_DETECTED
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_FAKE_VIDEO
FINAL_AUTHENTICATION_RESULT_REASON_REJECT_INVALID_SIGNATURE

۶. خطاهای دریافتی

CodeDescription
۴۲۹درخواست بیش از حد مجاز
۴۰۰درخواست نامعتبر
۵۰۰خطای داخلی سرور
۴۰۹شما قبلا احراز هویت شده اید
۴۰۴پذیرنده مورد نظر یافت نشد
۴۰۴کاربر مورد نظر یافت نشد
۵۰۳سرویس در دسترس نمی باشد
۴۰۳دسترسی غیر مجاز به سرویس
مشاوره رایگان