Отправка смс кода без регистрации

Данный раздел описывает хуки для отправки смс без отправки полей для регистрации.

Хук 1. Запрос отправки смс кода на указанный номер

Описание запроса

APP SERVER → INFRASTRUCTURE

{
    "phone": "79424124124",
    "userIdentifier": "79333332222"
  • phone - номер телефона указанный для отправки кода

  • userIdentifier - id пользователя в системе клиента, который запрашивает отправку смс

Описание ответа

В ответ бекенд клиента должен отправить аналогичный авторизации payload

 {
    "otp": {
        "timeout": 30,
        "attemptsLeft": 3,
        "message": "На номер 79424124124 отправлено сообщение с кодом",
        "codeLength": 4
    }
}

или

Возможно, SMS-шлюз не отзывается, либо нельзя использовать данный номер телефона

{
    "error": {
        "message": "Превышено количество попыток входа"
    }
}
  • message — сообщение для пользователя, описывающее проблему

Хук 2. Подтверждение кода полученного из смс

После получения кода пользователь должен ввести его в специальное поле, после чего бекенд imshop отправит следующий запрос

Описание запроса

{
    "phone": "72312312312",
    "code": "1231",
    "userIdentifier": "71424124124"
}
  • phone - номер на который был послан смс код

  • code - код, введенный пользователем

  • userIdentifier - id пользователя в системе клиента, который получил смс и ввел

Описание ответа

В ответ бекенд клиента должен ответить следующее, если введенный код верен

{
  "success": true
} 

И следующее если код неверен

{
  "success": false,
  "error": "Неверный код"
} 

Last updated