تمامی سرویسها نیاز است که مقدار cookie نشست برروی درخواست موجود باشد پس انگولار بر روی درخواستهای خود cookie را نیز ارسال میکند (نکتهای است که مقدار نشست در لیست cookieها قابل دسترسی در client نیست به علت httppnly بودن و مقدارش را client نمیتواند بفهمد و فقط در هر درخواست cookie را ارسال میکند).
در مورد توکن csrf :
بر روی cookie مقداری به نام XSRF-TOKEN قرار گرفته است که مقدارش برابر با توکن csrf است حال این کوکی دارای httponly برابر با false است بدین معنی که client میتواند به آن دسترسی پیدا کند. پس کلاینت باید مقدار آن را از کوکی خوانده و در هدر درخواستهای POST خود و تحت عنوان X-XSRF-TOKEN قراردهد و سمت سرور برابری مقدار کوکی و هدر درخواست چک میشود
آدرس سرویس : initiate-login/
بدنه درخواست : ندارد
متد : POST
نوع محتوا : application/x-www-form-urlencoded
پاسخ :
{ "next_page": "login", "next_page_action": "http://192.168.1.118:8095/send/otp", "next_page_data": { "login": { "user_info": { "loa": "LEVEL_2_2", "fields": { "mobile_number": { "priority": 1, "value": "09127998974", "status": "hidden" }, "national_number": { "priority": 2, "value": "", "status": "present" } } }, "client_info": { "scope_titles": "تلفن همراه، کد ملی", "client_name": "ايران", "client_id": "abara" }, "general_info": { "download_address": "http://192.168.1.118:8095/download", "deprecate_address": "http://192.168.1.118:8095/deprecate/" } } }, "ready_for_final_authenticate": false } |
توضیح پاسخ :
با فراخوانی این سرویس مشخص میشود که اصلا کاربر میتواند صفحه لاگین را ببیند یا اگر پاسخ خطا داشت صفحه خطا را ببیند یا صفحه لاگین را با حالت خطا ببیند.
نمونه پاسخ غلط (وقتی کاربر نیاز دارد فرآیند را از اول شروع کند)
{ "next_page": "error", "ready_for_final_authenticate": false, "error": { "reason": "اجازه دسترسی برای شما وجود ندارد، فرآیند را دوباره شروع کنید." } } |
اگر پاسخ با وضعیت 422 دریافت شد کاربر به آدرس موجود در بدنه پاسخ هدایتشود.
{ "redirect_address":"https://google.com" } |
آدرس سرویس : send/otp/
بدنه درخواست : اطلاعات کدملی (national_number) و شماره موبایل (mobile_number) به صورت form-urlencoded
متد : POST
نوع محتوا : application/x-www-form-urlencoded
پاسخ :
{ "next_page": "otp", "next_page_action": "http://192.168.1.118:8095/authenticate/first-page", "next_page_data": { "otp": { "code_expire_time": "45", "total_code_expire_time":"60", "otp_address": "http://192.168.1.118:8095/send/otp", "mobile_number": "09121234567", "remaining_wrong_attempt": 3 } }, "ready_for_final_authenticate": false } |
توضیح پاسخ :
اگر پاسخ با وضعیت 422 دریافت شد کاربر به آدرس موجود در بدنه پاسخ هدایتشود.
{ "redirect_address":"https://google.com" } |
آدرس سرویس : authenticate/first-page/
بدنه درخواست : کد واردشده (code) و اطلاعات کدملی (national_number) و شماره موبایل (mobile_number) به صورت form-urlencoded
متد : POST
نوع محتوا : application/x-www-form-urlencoded
پاسخ :
{ "next_page": "otp", "next_page_action": "http://192.168.1.118:8095/login", "ready_for_final_authenticate": true } |
توضیح پاسخ :
پاسخ خطا ( در صورتی که کاربر بیش از حد کد پیامکی را اشتباه واردکند و نیاز باشد صفحه pushotp نمایش دادهشود)
{ "next_page": "push_otp", "next_page_action": "http://192.168.1.118:8095/authenticate/first-page", "next_page_data": { "push_otp": { "code_expire_time": "173", "total_code_expire_time":"180", "otp_address": "http://192.168.1.118:8095/send/otp", "push_code_value": "108460", "mobile_number": "09121234567", "push_code_provider": "*725#", "push_otp_check_status_interval": 2, "dial_number":"*725*108460#" } }, "ready_for_final_authenticate": false, "error": { "reason": "کد اشتباه ارسال شده و تعداد دفعات خطا 1 میباشد" } } |
پاسخ خطا (در صورتی که شاهکار اطلاعات کاربر را قبول نکند)
{ "next_page": "login", "next_page_data": { "login": { "user_info": { "loa": "LEVEL_2_2", "fields": { "mobile_number": { "priority": 1, "value": "09127998974", "status": "hidden" }, "national_number": { "priority": 2, "value": "0016873408", "status": "present" } } }, "client_info": { "scope_titles": "تلفن همراه، کد ملی", "client_name": "ايران", "client_id": "abara" }, "general_info": { "download_address": "http://192.168.1.118:8095/download", "deprecate_address": "http://192.168.1.118:8095/deprecate/" } } }, "ready_for_final_authenticate": false, "error": { "reason": "این شماره موبایل با کدملی سازگار نمی باشد. تعداد دفعات خطا 1" } } |
در این حالت کاربر صفحه لاگین را میبیند و در آنجا پیام خطا toast میشود و اطلاعات موردنیاز هر صفحه در قسمت next_page_data قرار میگیرد.
پاسخ خطا (در صورتی که کد پیامکی اشتباه زده باشد)
{ "next_page": "otp", "next_page_action": "http://192.168.1.118:8095/authenticate/first-page", "next_page_data": { "otp": { "code_expire_time": "20", "total_code_expire_time":"60", "otp_address": "http://192.168.1.118:8095/send/otp", "mobile_number": "09124958820" } }, "ready_for_final_authenticate": false, "error": { "reason": "کد به درستی وارد نشده است. تعداد دفعات خطا 1" } } |
در این حالت کاربر در صفحه otp میماند و پیام خطا نشان داده میشود.
پاسخ درست (حالتی که مرحله بعد صفحه تشخیص چهره باشد)
{ "next_page": "facedetection", "next_page_action": "http://192.168.1.118:8095/authenticate/face-decetion", "next_page_data": { "facedetection": { ... } }, "ready_for_final_authenticate": false } |
در این حالت کاربر به صفحه تشخیص چهره هدایت میشود
اگر پاسخ با وضعیت 422 دریافت شد کاربر به آدرس موجود در بدنه پاسخ هدایتشود.
{ "redirect_address":"https://google.com" } |
آدرس سرویس : login/
بدنه درخواست : ندارد
متد : POST
نوع محتوا : application/x-www-form-urlencoded
پاسخ : اگر پاسخ با وضعیت 200 دریافت شد نشان دهندهی موفقیت آمیز بودن عملیات است و کاربر باید به آدرسی که در بنده درخواست است ریدایرکت شود ولی اگر پاسخ دیگری دریافت شد نشان دهندهی خطاست وهمانند پاسخهای خطای سرویسهای قبلی با آن رفتار شود.
{ "redirect_address" : "http://192.168.1.118:8095/...." } |
اگر پاسخ با وضعیت 422 دریافت شد کاربر به آدرس موجود در بدنه پاسخ هدایتشود.
{ "redirect_address":"https://google.com" } |
آدرس: /authenticate/face-detection/zoom-id-init
توضیح: این سرویس باید در ابتدای لود شدن فرم zoomid فراخوانی شود.
بدنه درخواست: ندارد
متد: POST
محتوای پاسخ:
مقدار is_enrolled مشخصکننده نمایش/عدم نمایش inputهای تاریخ تولد و سریال کارت ملی در این فرم است. در صورت true بودن این مقدار، نیازی به نمایش این inputها نیست.
مقدار ramaining_wrong_attemp نیز تعداد خطای ممکن ثبتنام/تطابق چهره را مشخص میکند.
مقدار next_page_action در صورت true بودن is_enrolled برابر/authenticate/face-detection/zoom-id و در غیر این صورت برابر /authenticate/face-detection/register خواهد بود
نمونه پاسخ موفق در صورت enrolled نبودن:
{ "next_page": "zoomid", "next_page_action": "/authenticate/face-detection/register", "next_page_data": { "zoomid": { "is_enrolled": false, "remaining_wrong_attempt": 3 } }, "ready_for_final_authenticate": false } |
نمونه پاسخ موفق در صورت enrolled بودن:
{ "next_page": "zoomid", "next_page_action": "/authenticate/face-detection/zoom-id", "next_page_data": { "zoomid": { "is_enrolled": true, "remaining_wrong_attempt": 3 } }, "ready_for_final_authenticate": false } |
نمونه پاسخ ناموفق (در صورتی که فراخوانی سرویس zoomid با خطای Timeout مواجه شود):
{ "next_page": "zoomid", "next_page_action": "/authenticate/face-detection/zoom-id-init", "next_page_data": { "zoomid": { "remaining_wrong_attempt": 3 } }, "ready_for_final_authenticate": false, "error": { "reason": "سرور تشخیص چهره در دسترس نیست" } } |
نمونه پاسخ ناموفق (در صورتی که فراخوانی سرویس zoomid با خطای ناشناخته مواجه شود):
{ "next_page": "error", "ready_for_final_authenticate": false, "error": { "reason": "خطا در فراخوانی سرویس تشخیص چهره" } } |
آدرس: /authenticate/face-detection/register
توضیح: این سرویس در صورتی مورد استفاده قرار میگیرد که در پاسخ zoom-id-init مقدار is_enrolled برابر false باشد و نیاز به ثبت نام کاربر باشد. تاریخ تولد و سریال کارت ملی کاربر در بدنه این درخواست قرار میگیرند.
بدنه درخواست: به صورت application/x-www-form-urlencoded شامل: تاریخ تولد با نام birth_date به صورت timestamp و سریال کارت ملی با نام national_serial به صورت رشته.
متد: POST
محتوای پاسخ: در صورتی که is_enrolled در پاسخ true باشد به معنی موفقیت در ثبت نام کاربر است. در صورت خطا هم remaining_wrong_attempt تعداد خطای ممکن باقیمانده را مشخص میکند.
نمونه پاسخ موفق:
{ "next_page": "zoomid", "next_page_action": "/authenticate/face-detection/zoom-id", "next_page_data": { "zoomid": { "is_enrolled": true, "remaining_wrong_attempt": 3 } }, "ready_for_final_authenticate": false } |
نمونه پاسخ ناموفق در صورت تطابق نداشتن اطلاعات کاربر:
{ "next_page": "zoomid", "next_page_action": "/authenticate/face-detection/register", "next_page_data": { "zoomid": { "is_enrolled": false, "remaining_wrong_attempt": 2 } }, "ready_for_final_authenticate": false, "error": { "reason": "اطلاعات کاربر تطابق ندارند" } } |
نمونه پاسخ ناموفق در صورت بیش از حد اشتباه وارد کردن اطلاعات کاربر با کد ۴۲۲ که در این حالت کاربر باید به آدرس موجود در پاسخ هدایت شود:
{ "redirect_address": "http://divar.com:9000/buy?error=too_many_attempt" } |
آدرس: /authenticate/face-detection/zoom-id
توضیح: این سرویس برای تعیین وضعیت احراز هویت کاربر پس از فراخوانی سرویس تطابق چهره توسط ماژول zoomid استفاده میشود. در callback فراخوانی سرویس تطابق چهره ماژول zoomid، با فراخوانی این سرویس وضعیت احراز هویت کاربر بررسی میشود.
بدنه درخواست: ندارد
متد: POST
محتوای پاسخ: در صورتی که از قبل کاربر با موفقیت سرویس تطابق چهره را فراخوانی کرده باشد، مشابه سایر سرویسهای احراز هویت، مقدار ready_for_final_authentication با مقدار true برگردانده میشود. در غیر این صورت هم مقدار emaining_wrong_attempt تعداد خطای ممکن باقیمانده را مشخص میکند.
نمونه پاسخ موفق:
{ "next_page": "zoomid", "next_page_action": "/login", "ready_for_final_authenticate": true } |
نمونه پاسخ ناموفق در صورتی که چهره کاربر تطابق نداشته باشد:
{ "next_page": "zoomid", "next_page_action": "/authenticate/face-detection/zoom-id", "next_page_data": { "zoomid": { "is_enrolled": true, "remaining_wrong_attempt": 3 } }, "ready_for_final_authenticate": false } |
نمونه پاسخ ناموفق در صورت اتمام تلاشهای ممکن برای تطابق چهره با کد ۴۲۲ که در این حالت کاربر باید به آدرس موجود در پاسخ هدایت شود:
{ "redirect_address": "http://divar.com:9000/buy?error=too_many_attempt" } |