Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

مقدار ramaining_wrong_attemp نیز تعداد خطای ممکن ثبت‌نام/تطابق چهره را مشخص می‌کند.

مقدار next_page_action در صورت true بودن is_enrolled برابر/authenticate/face-detection/zoom-id و در غیر این صورت برابر /authenticate/face-detection/register خواهد بود

نمونه پاسخ موفق در صورت enrolled نبودن:

Code Block
languagejs
titlezoom-id-init successful not enrolled example
{
    "next_page": "zoomid",
    "next_page_action": "/authenticate/face-detection/zoom-idregister",
    "next_page_data": {
        "zoomid": {
            "is_enrolled": false,
            "remaining_wrong_attempt": 3
        }
    },
    "ready_for_final_authenticate": false
}

نمونه پاسخ ناموفق (در صورتی که فراخوانی سرویس zoomid با خطا مواجه شود)موفق در صورت enrolled بودن:

Code Block
languagejs
titlezoom-id-init failed successful enrolled example
{
    "next_page": "loginzoomid",
    "next_page_action": "/authenticate/face-detection/firstzoom-pageid",
    "next_page_data": {
        "loginzoomid": {
            "useris_infoenrolled": {true,
                "loa"remaining_wrong_attempt": "LEVEL_3_1",
        }
    },
    "fieldsready_for_final_authenticate": false
}

نمونه پاسخ ناموفق (در صورتی که فراخوانی سرویس zoomid با خطای Timeout مواجه شود):

Code Block
languagejs
titlezoom-id-init timedout example
{
       "next_page": "zoomid",
         "next_page_action": "/authenticate/face-detection/zoom-id-init",
    "mobilenext_page_numberdata": {
            "zoomid": {
            "priorityremaining_wrong_attempt": 1,3
        }
    },
    "ready_for_final_authenticate": false,
       "valueerror": "09190019974",{
        "reason": "سرور تشخیص چهره در دسترس نیست"
    }
}

نمونه پاسخ ناموفق (در صورتی که فراخوانی سرویس zoomid با خطای ناشناخته مواجه شود):

Code Block
languagejs
titlezoom-id-init failed example
{
      "statusnext_page": "hiddenerror",
                    },
  "ready_for_final_authenticate": false,
                  "national_number"error": {
                        "priority"reason": 2,
"خطا در فراخوانی سرویس تشخیص چهره"
                   "value": "1990619746",
                        "status": "hidden"
                    }
                }
            },
            "client_info": {
                "scope_titles": "تلفن همراه",
                "client_name": "ديوار",
                "client_id": "divar"
            },
            "general_info": {
                "download_address": "/download",
                "deprecate_address": "/deprecate"
            }
        }
    },
    "ready_for_final_authenticate": false,
    "error": {
        "reason": "خطا در فراخوانی سرویس تشخیص چهره"
    }
}

سرویس ثبت نام zoom-id

آدرس: /authenticate/face-detection/zoom-id

}
}


سرویس ثبت نام zoom-id

آدرس: /authenticate/face-detection/register

توضیح: این سرویس در صورتی مورد استفاده قرار می‌گیرد که در پاسخ zoomتوضیح: این سرویس در صورتی مورد استفاده قرار می‌گیرد که در پاسخ zoom-id-init مقدار is_enrolled برابر false باشد و نیاز به ثبت نام کاربر باشد. تاریخ تولد و سریال کارت ملی کاربر در بدنه این درخواست قرار می‌گیرند.

بدنه درخواست: به صورت application/x-www-form-urlencoded شامل: تاریخ تولد با نام birth_date به صورت timestamp و سریال کارت ملی با نام national_serial به صورت رشته. 

متد: POST

محتوای پاسخ: در صورتی که is_enrolled در پاسخ true باشد به معنی موفقیت در ثبت نام کاربر است. در صورت خطا هم remaining_wrong_attempt تعداد خطای ممکن باقی‌مانده را مشخص می‌کند.

نمونه پاسخ موفق:

Code Block
languagejs
titlezoom-id register successful example
{
    "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
}

باشد. تاریخ تولد و سریال کارت ملی کاربر در بدنه این درخواست قرار می‌گیرند.

بدنه درخواست: به صورت application/x-www-form-urlencoded شامل: تاریخ تولد با نام birth_date به صورت timestamp و سریال کارت ملی با نام national_serial به صورت رشته. 

متد: POST

محتوای پاسخ: در صورتی که is_enrolled در پاسخ true باشد به معنی موفقیت در ثبت نام کاربر است. در صورت خطا هم remaining_wrong_attempt تعداد خطای ممکن باقی‌مانده را مشخص می‌کند.

نمونه پاسخ موفقنمونه پاسخ ناموفق در صورت تطابق نداشتن اطلاعات کاربر:

Code Block
languagejs
titlezoom-id register failed successful example
{
    "next_page": "zoomid",
    "next_page_action": "/authenticate/face-detection/zoom-id",
    "next_page_data": {
        "zoomid": {
            "is_enrolled": falsetrue,
            "remaining_wrong_attempt": 23
        }
    },
    "ready_for_final_authenticate": false,
    "error": {
        "reason": "اطلاعات کاربر تطابق ندارند"
    }
}

نمونه پاسخ ناموفق در صورت بیش از حد اشتباه وارد کردن تطابق نداشتن اطلاعات کاربر:

Code Block
languagejs
titlezoom-id register failed example
{
    "next_page": "zoomid",
    "next_page_action": "/authenticate/face-detection/zoom-idregister",
    "next_page_data": {
        "zoomid": {
            "is_enrolled": false,
            "remaining_wrong_attempt": 2
        }
    },
    "ready_for_final_authenticate": false,
    "error": {
        "reason": "اطلاعات کاربر تطابق ندارند"
    }
}

سرویس تعیین وضعیت zoomid

آدرس: /authenticate/face-detection/zoom-id

توضیح: این سرویس برای تعیین وضعیت کاربر پس از فراخوانی سرویس تطابق چهره توسط ماژول zoomid استفاده می‌شود. در callback فراخوانی سرویس تطابق چهره ماژول zoomid، با فراخوانی این سرویس وضعیت احراز هویت کاربر بررسی می‌شود.

بدنه درخواست: ندارد

متد: POST

محتوای پاسخ: در صورتی که is_enrolled در پاسخ true باشد به معنی موفقیت در ثبت نام کاربر است. در صورت خطا هم remaining_wrong_attempt تعداد خطای ممکن باقی‌مانده را مشخص می‌کند.

 "reason": "اطلاعات کاربر تطابق ندارند"
    }
}

نمونه پاسخ ناموفق در صورت بیش از حد اشتباه وارد کردن اطلاعات کاربر با کد ۴۲۲ که در این حالت کاربر باید به آدرس موجود در پاسخ هدایت شودنمونه پاسخ موفق:

Code Block
languagejs
titlezoom-id check successful register failed example
{
    "nextredirect_pageaddress": "zoomid",
    "next_page_action": "http://divar.com:9000/buy?error=too_many_attempt"
}

سرویس احراز هویت zoom-id

آدرس: /authenticate/face-detection/zoom-id

...

توضیح: این سرویس برای تعیین وضعیت احراز هویت کاربر پس از فراخوانی سرویس تطابق چهره توسط ماژول zoomid استفاده می‌شود. در callback فراخوانی سرویس تطابق چهره ماژول zoomid، با فراخوانی این سرویس وضعیت احراز هویت کاربر بررسی می‌شود.

بدنه درخواست: ندارد

متد: POST

محتوای پاسخ: در صورتی که از قبل کاربر با موفقیت سرویس تطابق چهره را فراخوانی کرده باشد، مشابه سایر سرویس‌های احراز هویت، مقدار ready_for_final_authentication با مقدار true برگردانده می‌شود. در غیر این صورت هم مقدار emaining_wrong_attempt تعداد خطای ممکن باقی‌مانده را مشخص می‌کند.

نمونه پاسخ موفقنمونه پاسخ ناموفق در صورتی که چهره کاربر تطابق نداشته باشد:

Code Block
languagejs
titlezoom-id check failed examplesuccessful example
{
{
    "next_page": "zoomid",
    "next_page_action": "/authenticate/face-detection/zoom-id",
    "next_page_data": {
        "zoomid"next_page": {
            "is_enrolled": true,
     "zoomid",
       "remainingnext_wrongpage_attemptaction": 3
        }
    }"/login",
    "ready_for_final_authenticate": falsetrue
}

نمونه پاسخ ناموفق در صورت اتمام تلاش‌های ممکن برای تطابق چهرهصورتی که چهره کاربر تطابق نداشته باشد:

Code Block
languagejs
titlezoom-id check failed example
{
    "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
}

نمونه پاسخ ناموفق در صورت اتمام تلاش‌های ممکن برای تطابق چهره با کد ۴۲۲ که در این حالت کاربر باید به آدرس موجود در پاسخ هدایت شود:

Code Block
languagejs
titlezoom-id check failed example
{
    "redirect_address": "http://divar.com:9000/buy?error=too_many_attempt"
}