Versions Compared

Key

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

...

Code Block
languagetext
titleنمونه پاسخ درست ارسال پیامک
"error": {
         "next_page": "it can be currentany or error or anypage orerror page ",
 if it is current stay there and toast the reason and if it is error page print it on the error page dont need to toast but for another pages toast the reason",
        "reason": """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
    }

...

  1. در قسمت error در صورتی که خطایی رخ داده باشد این فیلد در پاسخ قرار می‌گیرد و در صورت موفقیت آمیز بودن درخواست اثری از آن نیست
    1. فیلد next_page : وقتی برابر صفحه error باشد حالتی است که در آن باید کاربر را به صفحه error برد و در آنجا مقدار فیلد reason را در آن صفحه نشان داد.
    2. فیلد next_page : وقتی برابر صفحه ای مثل login, otp  و یا push otp باشد باید مقدار خطا را در آن صفحه به صورت toast نشان دهد (اگر مقدار فیلد next_page با صفحه جاری برابر بود به طبع دیگر نیازی به تغییر صفحه نیست و همانجا باید پیام خطا toast شود) 
      فیلد reason : نشان دهنده دلیل خطاست.

    3. فیلد next_page_action : آدرسی که دکمه موجود در آن صفحه حاوی خطا نیاز است تا کاربر فراخوانی کند.
    4. فیلد next_page_data : اطلاعاتی که در آن صفحه حاوی خطا نیاز است تا در صفحه نمایش داده بشود.
  2. در قسمت success  در صورتی که عملیات با موفقیت انجام شود این فیلد در پاسخ قرار می‌گیرد.
    1. فیلد next_page : صفحه بعدی را نشان می‌دهد الزاما این صفحه همواره صفحه ی بعد نیست مانند حالتی که سامانه پیامکی دچار مشکل شده‌است و پس از درخواست /send/otp باید در همان صفحه login بمانیم.
    2. فیلد next_page_action : آدرسی که دکمه موجود در صفحه otp برای واردنمودن کد دریافت شده توسط کاربر را نشان می‌دهد
    3. فیلد next_page_data : اطلاعاتی که در صفحه آتی (اینجا otp) است را شامل می‌شود
    4. فیلد ready_for_final_authenticate : اگر برابر true بود در پاسخ هر سرویسی به منظور آن است که کاربر تمام مراحل احرازهویت موردنظر را به پایان رسانده است و باید درخواست login/ فراخوانی شود. که در جواب این درخواست کاربر redirect می‌شود.

...