API для SDK

Данный эндпоинт обеспечивает интеграцию двухфакторной аутентификации в пользовательские приложения. Реализация построена по принципу бесшовной интеграции, что обеспечивает плавный пользовательский опыт.

Доступ к API

Перед использованием данного API необходимо включить расширенное API в личном кабинете, в разделе «Настройки API» и использовать API Key и API Secret, предоставленные в разделе.

Привязка аккаунта в приложении

Адрес: https://api.multifactor.ru/access/requests/enrollment | метод POST

 Запрос инициирует процесс привязки мобильного приложения к аккаунту пользователя.

В ответ сервер возвращает уникальный идентификатор запроса requestId, который необходимо передать в мобильное приложение для завершения процесса.

Пример запроса:

curl --location 'https://api.multifactor.dev/access/requests/enrollment' \  # URL эндпоинта для регистрации MFA
--header 'Content-Type: application/json' \  # Указываем, что передаем данные в формате JSON
--header 'Authorization: ••••••' \  # Токен авторизации для доступа к API 
--data-raw '{                       # Начало JSON данных запроса
  "identity": "user@email.com",     # Email пользователя для регистрации в MFA
  "ttl": 300                        # Время жизни запроса в секундах (300 сек = 5 минут)
}'                                  # Конец JSON данных

Пример ответа:

{
    "model": {
        "requestId": "RPYyo22NEoL" // Уникальный идентификатор запроса на регистрацию MFA
    },
    "success": true // Флаг успешного выполнения запроса
}

Возможные ошибки:

{
    "errors": {
        "RequestId": [
            "The RequestId field is required."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-17271e40b1758a01bcc8b37998f62e8b-76038f8ddc433a6a-00"
}

{
    "type": "https://tools.ietf.org/html/rfc9110#section-15.5.2",
    "title": "Unauthorized",
    "status": 401,
    "traceId": "00-4dbdc446326128d3a6fff2d05ed63270-7da9e0f0b2d86b5a-00"
}

Registration for request 'RequestId' not allowed.

Request 'RequestId' not found.

Смотрите также:

Настройка SDK для двухфакторной аутентификации