Как настроить 2FA-интеграцию
Настройка 2FA-интеграции — сторона генерации, канал, параметры кода
Коротко: 2FA-интеграция настраивается в разделе «2FA Service». Вы выбираете сторону генерации, канал отправки и параметры кода.
Кому подходит
- Роль: Клиент, Администратор
- Уровень: Опытный
Что это
2FA-интеграция — это подключение OTP-кодов к вашему сайту или сервису через раздел 2FA Service. В одной интеграции можно:
- Выбрать, где генерируется код.
- Настроить параметры кода — количество цифр, срок действия.
- Выбрать канал и имя отправителя.
Перед началом
- Вы в личном кабинете OTP-кодов.
- У вас есть имя отправителя со статусом Активно.
- У вас есть API-ключ.
Раздел 2FA Service — для режима «На стороне платформы».
Платформа сама генерирует код, отправляет его и проверяет. Вам не нужно писать свою логику генерации и хранения кодов.
Если вам нужна генерация и проверка кода на своей стороне — используйте режим Умный шлюз.
Шаги
В левом меню: 2FA Service → 2FA SMS.
Кнопка в правом верхнем углу.
В поле Генерация и проверка кода выберите значение На стороне платформы.
| Значение | Когда использовать |
|---|---|
| На стороне платформы | Платформа генерирует и проверяет код. Этот вариант используется в разделе 2FA Service |
| На стороне клиента | Вы генерируете и проверяете код на своей стороне. Настраивается через режим Умный шлюз |
В разделе 2FA Service используется только вариант «На стороне платформы».
Если вам нужна генерация кода на своей стороне — перейдите в режим Умный шлюз.
Понятное имя записи. Например, «2FA для сайта».
Имя отправителя, от которого будут отправляться коды.
| Поле | Что указать |
|---|---|
| Количество цифр в коде | 4, 5, 6 или больше |
| Период валидности кода | В секундах, максимум 600 |
| URL для результата верификации | Куда отправлять результат (необязательно) |
Введите текст с плейсхолдером {{code}}. Например: «Ваш код: {{code}}».
В разделе Данные для интеграции нажмите кнопку генерации. Ключ появится в поле API key.
Скопируйте:
- API key.
- URL для интеграции.
| Кнопка | Что делает |
|---|---|
| Сохранить как черновик | Сохраняет со статусом Черновик |
| Сохранить и запустить сервис | Активирует интеграцию |
Результат
2FA-интеграция настроена. Статус — Активный.
Тестирование
Возможность тестирования становится доступна после создания интеграции:
- Откройте карточку интеграции.
- Введите номер телефона для теста.
- Нажмите Отправить тестовый код.
- Проверьте, что код пришёл.
URL-адрес статуса обработки обратного вызова — задайте, если хотите получать статусы доставки через вебхук.
Статусы интеграции
| Статус | Что означает |
|---|---|
| Активный | Работает |
| Черновик | Не активирована |
| Заблокированный | Отключена |
Частые проблемы
Причина: не заполнено обязательное поле.
Решение: проверьте форму — все обязательные поля должны быть заполнены.
Причина: неверный номер телефона или проблема у оператора.
Решение: проверьте номер — он должен быть в международном формате, без знака +. Например, для России: 79991234567.
Причина: неверный API-ключ интеграции.
Решение: сверьте ключ в разделе Данные для интеграции.
Причина: раздел 2FA Service работает только с генерацией на стороне платформы.
Решение: используйте режим Умный шлюз.
См. также
Нужна помощь?
- OTP-коды: support@otpcod.ru