...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"user_info": {
"mobile_number": "",
"national_number": "",
"loa": ""
},
"client_info": {
"scope_titles": "",
"client_name": "",
"client_logo": "base64 of client logo, we dont need client id and download address any more"
},
"next_page_action":"/send/otp"
} |
...
- در قسمت user_info اطلاعات کاربر قرار دارد
- در قسمت client_info اطلاعات نهاد متکی قراردارد و دیگر نیازی به فراخوانی سرویس download برای logo نیستیم و در همین پاسخ برگردانده میشود
- فیلد next_page_action نشان دهنده آدرس دکمه ادامه است.
سرویس ارسال پیامک
آدرس سرویس : send/otp/
...
Code Block | ||||
---|---|---|---|---|
| ||||
"error": { "next_page": "it can be any page orerroror error page", "reason": "error reason", "next_page_action":"/authenticate/first-page", "next_page_data":{} }, "success": { "next_page": "otp", "next_page_action":"/authenticate/first-page" "next_page_data":{ "code_expire_date":12312 }, "ready_for_final_authenticate": false } |
...
- در قسمت error در صورتی که خطایی رخ داده باشد این فیلد در پاسخ قرار میگیرد و در صورت موفقیت آمیز بودن درخواست اثری از آن نیست
- فیلد next_page : وقتی برابر صفحه error باشد حالتی است که در آن باید کاربر را به صفحه error برد و در آنجا مقدار فیلد reason را در آن صفحه نشان داد.
- فیلد next_page : وقتی برابر صفحه ای مثل login, otp و یا push otp باشد باید مقدار خطا را در آن صفحه به صورت toast نشان دهد (اگر مقدار فیلد next_page با صفحه جاری برابر بود به طبع دیگر نیازی به تغییر صفحه نیست و همانجا باید پیام خطا toast شود)
فیلد reason : نشان دهنده دلیل خطاست. - فیلد next_page_action : آدرسی که دکمه موجود در آن صفحه حاوی خطا نیاز است خطا، دربر دارد تا کاربر آن را فراخوانی کند.
- فیلد next_page_data : اطلاعاتی که در آن صفحه حاوی خطا خطا، نیاز است تا در صفحه نمایش داده بشود.
- در قسمت success در صورتی که عملیات با موفقیت انجام شود این فیلد در پاسخ قرار میگیرد.
- فیلد next_page : صفحه بعدی را نشان میدهد الزاما این صفحه همواره صفحه ی بعد نیست مانند حالتی که سامانه پیامکی دچار مشکل شدهاست و پس از درخواست /send/otp باید در همان صفحه login بمانیم .
- فیلد next_page_action : آدرسی که دکمه موجود در صفحه otp برای واردنمودن کد دریافت شده توسط کاربر را نشان میدهد
- فیلد next_page_data : اطلاعاتی که در صفحه آتی (اینجا otp) است را شامل میشود
- فیلد ready_for_final_authenticate : اگر برابر true بود در پاسخ هر سرویسی به منظور آن است که کاربر تمام مراحل احرازهویت موردنظر را به پایان رسانده است و باید درخواست login/ فراخوانی شود. که در جواب این درخواست کاربر redirect میشود.
...
Code Block | ||||
---|---|---|---|---|
| ||||
"error": { "next_page": "otp", "reason": "otp was incorrect", "next_page_action":"/authenticate/first-page", "next_page_data":{ "code_expire_date":1111 } } |
در این حالت کاربر در صفحه otp میماند و پیام خطا نشان داده میشود.
پاسخ درست (حالتی که مرحله بعد صفحه تشخیص چهره باشد)
Code Block | ||||
---|---|---|---|---|
| ||||
"success": { "next_page": "facedetection", "next_page_action":"/authenticate/face-decetion" "next_page_data":{...}, "ready_for_final_authenticate": false } |
در این حالت کاربر به صفحه تشخیص چهره هدایت میشود