احراز هویت تصویری

خدمت‌دهنده

بازارچه پادیوم

فراخوانی آزمایشی _BETA اطلاعات مجموعه سرویس

مقدمه

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

این سرویس می‌تواند از عکس کارت ملی و یا هر عکس دیگری استفاده کند. همچنین ساختار ویدیو سلفی باید منطبق بر استانداردهای پاد باشد.

پیش از شروع

URL فراخوانی سرویسها:

Production Server: https://api.pod.ir/srv/sc/nzh/doServiceCall

Sandbox Server:https://sandbox.pod.ir/srv/sc/nzh/doServiceCall

تمامی درخواستها با متد POST ارسال میشوند.
فیلدهای زیر درHeader تمامی درخواستها ثابت است:

پارامتر	توضیحات
_token_	توکن کسبوکاری دریافتی از پنل
_token_issuer_	مقدار ثابت "1"

فیلدهای زیر در بدنه‌ی تمامی درخواست‌ها ثابت است (با فرمت x-www-form-urlencoded):

پارامتر	توضیحات
scProductId	شناسه‌ی سرویس مدنظر
scApiKey	راهنمای دریافت این پارامتر در این لینک موجود است.

علاوه بر موارد بالا که ثابت هستند، اگر سرویس نیاز به پارامتر دیگری داشته باشد در داکیومنت مربوطه ذکر شده است.
خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.

نکته: پس از درخواست سرویس به پادیوم، همکاران ما درخواستهای ارسالی را بررسی می‌کنند. در صورت عدم دریافت تایید کرد بر روی درخواست ارسالی ظرف یک روز کاری،به همکاران ما از طریق شماره تلفن (021-89518989) و یا در گروه واتس‌اپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.

ثبت درخواست شناسه سرویس: 3828143 ( سندباکس: ندارد )
user_verification_using_video_clip جهت ثبت درخواست بررسی باید از این سرویس به همراه پارامترهای زیر استفاه شود . توجه داشته باشید در صورتی که درخواست به هر دلیلی قابل دریافت نباشد ، فیلد hasError برابر با true خواهد شد . نمونه سلفی ارسالی: به منظور استفاده صحیح از سرویس در راستای دستیابی به دقت موردنظر ، می بایست سلفی ارسالی از استاندارهای زیر برخوردار باشد : تلفن همراه در زمان ضبط سلفی باید به صورت افقی گرفته شود . فاصله تلفن همراه تا چهره فرد حداکثر باشد ( یعنی در زمان ضبط سلفی ، فرد دست خود را کاملا راست و مستقیم نگاه دارد ) فرد می بایست برای ضبط سلفی ابتدا 2 تا 3 ثانیه مستقیم به دوربین نگاه بکند ، و سپس یکبار سر خود را به چپ و راست بچرخاند. مدت زمان سلفی کمتر از 1- ثانیه باشد . توجه داشته باشید ، در صورتی که استاندارهای فوق در ضبط سلفی رعایت نشود مراحل احراز هویت فرد با مشکل مواجه خواهد شد . تشریح خروجی سرویس: پس از دریافت درخواست و پردازش آن ، نتیجه پردازش به Callback URL ایی که به عنوان ورودی از فراخواننده سرویس دریافت شده بود ارسال میگردد . فرمت خروجی سرویس با فرمت JSON و به صورت زیر می باشد . در صورتی که درخواست موفق رخ دهد و تصاویر باهم منطبق باشند : statusCode=200 : عملیات به درستی انجام شده است و خروجی به صورت زیر خواهد بود : json confidence ، در صد شباهت را نشان می دهد verifyStatus نشانگر وضعیت است ، اگر مقدار این برابر با 1 باشد ، یعنی دو تصویر متعلق به یک شخص هستند. در صورتی که درخواست موفق رخ دهد و تصاویر باهم منطبق نباشند : statusCode=200 : عملیات به درستی انجام شده است و خروجی به صورت زیر خواهد بود . json confidence ، در صد شباهت را نشان می دهد verifyStatus نشانگر وضعیت است ، اگر مقدار این برابر با 0 باشد ، یعنی دو تصویر متعلق به یک شخص نیستند . در صورتی که درخواست موفق رخ ندهد : statusCode=462 : یکی از تصاویر یا چهره ندارد و یا بیش از یک چهره دارد . json verifyStatus در صورتی که -1 باشد یعنی یکی از تصاویر دارای چهره نیست ، در صورتی که -2 باشد یعنی سلفی ارسالی Live نیست . در صورت بروز هر گونه مشکل در فرایند پردازش تصویر ، براساس نوع خطای رخداده ، کدهای خانواده 400 و 500 در statusCode آورده خواهد شد و پیغام مناسب برای تشریح خطای موردنظر در پارامتر message آورده میشود .
توضیحات	مقدار	نام پارامتر
ورودی
Header
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است	yourBusinessToken	_token_
این پارامتر همواره دارای مقدار ثابت 1 است .	1	_token_issuer_
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد	application/x-www-form-urlencoded	Content-Type
Body
شناسه سرویس	3828143	scProductId
کلید فراخوانی سرویس		scApiKey

الزامی – آدرس URL تصویر کارت ملی ( یا تصاویر دیگر فرد ) بار گزاری شده در پاد اسپیس .		imageHash
ادرس URL ویدئو سلفی فرد بارگزاری شده در پاد اسپیس		videoHash
الزامی – به فرمت UUID – شناسه ای که توسط فراخواننده سرویس به عنوان tracker برای callback تعیین میشود.		callbackTracker
الزامی - شناسه کسب وکار فراخونی کننده سرویس ، جهت ردگیری سرویس و پاسخ آن ارسال می گردد		businessId
الزامی- URL که نتیجه پردازش درخواست موردنظر به آن ارسال میگردد ، که توسط فراخوانی کننده باید مقدار دهی شود .		callbackUrl
خروجی
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود	true/false	hasError
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید.	string	referenceNumber
نتیجه ی نهایی سرویس که شامل یک JSON Object است .	string	result.result
محتویات پارامتر result.result
	true/false	hasError
نتیجه فراخوانی سرویس که شامل یک JSON Object و حاوی دو پارامتر confidence و verifyStatus است .		result
در صد شباهت را نشان می دهد		confidence
نشانگر وضعیت تطبیق دو تصویر است		verifyStatus
HttpStatusCode که نتیجه نهایی فراخوانی سرویس را مشخص می نمایید .		statusCode
نمونه درخواست
html
نمونه پاسخ
json

استعلام وضعیت درخواست شناسه سرویس : 3828144 ( سندباکس : ندارد )
همانطور که در بخش مقدمه اشاره شد ، به محض دریافت صحیح یک درخواست ، وضعیت پردازش آن در پایگاه داده مرتبط ذخیره میگردد ، سپس با پردازش و تغییر وضعیت درخواست ، رکورد مربوط به آن در پایگاه داده بروز رسانی می گردد ، در نهایت به کمک این سرویس وضعیت درخواستهای سرویس Face Verification که در پایگاه داده مربوطه ذخیره شده اند را میتوان دریافت نمود.
توضیحات		مقدار	نام پارامتر
ورودی
Header
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است		yourBusinessToken	_token_
این پارامتر همواره دارای مقدار ثابت 1 است .		1	_token_issuer_
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد		application/x-www-form-urlencoded	Content-Type
Body
شناسه سرویس		3828144	scProductId
کلید فراخوانی سرویس			scApiKey

الزامی - شناسه کسب وکار مورد نظر			businessId
الزامی - شناسه یکتای درخواست			tracker
خروجی
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود		true/false	hasError
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید.		string	referenceNumber
نتیجه ی نهایی سرویس که شامل یک JSON Object است .		string	result.result
محتویات پارامتر result.result
در صورتی که درخواست با خطا مواجه شده باشدtrueو در غیر این صورتfalseمی گیرد.		true/false	hasError
HttpStatusCode که نتیجه نهایی فراخوانی سرویس را مشخص می نمایید . میتواند شامل بخش شماره کدهای زیر باشد : 200 – بازیابی موفق وضعیت درخواست 400 – خطا در پارامترهای ورودی 404- اشتباه در نام سرویس 500 – خطای داخلی سرور			statusCode
HttpStatusCode که نتیجه نهایی فراخوانی سرویس را مشخص می نمایید . میتواند شامل بخش توضیح کدهای زیر باشد : 200 – بازیابی موفق وضعیت درخواست 400 – خطا در پارامترهای ورودی 404- اشتباه در نام سرویس 500 – خطای داخلی سرور			statusText
اطلاعات وضعیت درخواست ، در این پارامتر بازگردانده می شود که میتواند شامل مقادیر زیر باشد: Tracker شناسه ی یکتای درخواست businessId شناسه کسب وکار مورد نظر requestStatusCode کد وضعیت درخواست requestStatusText پیام وضعیت درخواست Result نتیجه پردازش درخواست ( که در بخش "تشریح خروجی درخواست" آورده شده است ) Reason علت نتیجه پردازش درخواست comparisonState وضعیت احراز هویت *شرح مقادیر مختلف فیلد requestStatusCode و requestStatusText در جدول زیر آورده شده است: requestStatusCode / requestStatusText / Description 1 / Reject request / درخواست رد شده است 2 / AI Await / درخواست به درستی دریافت شده و در صف پردازش قرار گرفته است 3 / Done / پردازش درخواست و ارسال نتیجه آن با موفقیت انجام شده است 4 / Send response Failed ! / پردازش درخواست با موفقیت انجام شده ولی ارسال نتیجه به ادرس بازگشت کالبک با خطا مواجه شده است .			result
نمونه درخواست
html
نمونه پاسخ
json
خطاهای معمول در پلتفرم
کد خطا	توضیح
21	توکن کسبوکاری وارد نشده است
227	تایم اوت سرویس اصلی
378	ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است
403	اجازه انجام انتقال وجه را ندارید" – شما دسترسی لازم به شماره حساب مبدا را ندارید.