Реализация 2-х факторной авторизации

Методы

GET Создание объекта PasswordObject —
GET Получить все объекты PasswordObjects —
GET Получить объект PasswordObject по ID —
GET Редактирование объекта PasswordObject —
GET Удаление объекта PasswordObject —
GET Отправить SMS с кодом подтверждения —
GET /api/v1/createPasswordObject Создание объекта PasswordObject
URL запроса
GET https://app.sms.by/api/v1/createPasswordObject

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
type_id query string Да Может принимать следующие значения: letters - только буквы латинского алфавита, numbers - только цифры, both - смешанный тип
len query integer Да Длина пароля от 1 до 16

Ответы

200 — Выполнено успешно

{
    "result": {
        "password_object_id": 243
    }
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getPasswordObjects Получить все объекты PasswordObjects
URL запроса
GET https://app.sms.by/api/v1/getPasswordObjects

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ

Ответы

200 — Выполнено успешно

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getPasswordObject Получить объект PasswordObject по ID
URL запроса
GET https://app.sms.by/api/v1/getPasswordObject

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
id query integer Да ID объекта возвращаемое из createPasswordObject

Ответы

200 — Выполнено успешно

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/editPasswordObject Редактирование объекта PasswordObject
URL запроса
GET https://app.sms.by/api/v1/editPasswordObject

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
id query integer Да ID объекта возвращаемое из createPasswordObject
type_id query string Да Может принимать следующие значения: letters - только буквы латинского алфавита, numbers - только цифры, both - смешанный тип
len query integer Да Длина пароля от 1 до 16

Ответы

200 — Выполнено успешно

{
    "result": "1"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/deletePasswordObject Удаление объекта PasswordObject
URL запроса
GET https://app.sms.by/api/v1/deletePasswordObject

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
id query integer Да ID объекта возвращаемое из createPasswordObject

Ответы

200 — Выполнено успешно

{
    "result": "1"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/sendSmsMessageWithCode Отправить SMS с кодом подтверждения
URL запроса
GET https://app.sms.by/api/v1/sendSmsMessageWithCode

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
password_object_id query integer Да ID объекта возвращаемое из createPasswordObject
phone query string Да Номер телефона
message query string Да сообщение должно обязательно содержать переменную для подстановки %CODE%) Например: message = Ваш пароль: %CODE%
alphaname_id query integer Нет смотрите использование Альфа-имен

Ответы

200 — Выполнено успешно

{
    "status": "ok",
    "parts": 1,
    "len": 21,
    "sms_id": 2208471,
    "code": "GAYXILYZOX"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен