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

IMSHOP Retail Protocol (IRP) является объектом интеллектуальной собственности ООО «АЙ ЭМ СОЛЮШНЗ» (IMSHOP) и защищён как объект авторского права. Свидетельство о депонировании произведения № 023-014461 от 16 января 2023 г. подтверждает исключительные права ООО «АЙ ЭМ СОЛЮШНЗ» на данные технологии.

IMSHOP Retail Protocol создан по заказу ООО «АЙ ЭМ СОЛЮШНЗ». Использование IMSHOP Retail Protocol допустимо только при взаимодействии с ООО "АЙ ЭМ СОЛЮШНЗ" и наличии действующего лицензионного договора. Более подробно можно ознакомиться здесь.

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

Ендпоинт 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": "Неверный код"
}