REST API

Примечание

Для получения доступа к REST API необходим токен. Получение токена описано во вкладке с дополнительной информацией.


OTPSender API

Предоставляет API для доставки одноразовых паролей пользователю.

Информация о модуле

Подробная информация о модуле.

GET
/v1/info
Получение подробной информации о модуле.
Запрос
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9367/v1/info | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
version body string Номер версии модуля.

Пример получения информации о модуле в JSON формате:

{
    "info": {
        "version": "1.3"
    }
}

Одноразовые пароли

API для работы с одноразовыми паролями.

POST
/v1/otp/send
Отправка одноразового пароля.
Запрос
Параметры запроса:
Name In Type Description
user_id body string Идентификатор пользователя.
method body string Способ доставки одноразового пароля. Допустимые значения: telegram, email.
Пример запроса:
curl -X POST -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"user_id": "4624d46153f04fdb963a16754f8b5d0a", "method": "telegram"}' http://controller:9367/v1/otp/send

Эта операция не имеет содержания ответа.

Подробное описание кодов ответа на запросы доступно во вкладке с дополнительной информацией.