---
title: API 2FA Service — обзор
description: API 2FA Service — Basic Auth, отдельный ключ, эндпоинты для отправки и проверки кодов
---

> **For AI agents:** the complete documentation index is at [llms.txt](https://iba-platform.jamdesk.app/llms.txt). Append `.md` to any page URL for its markdown version.

> **Коротко:** API 2FA Service — отдельный интерфейс для подключения 2FA к вашему сайту. Отличается от OMNI API: аутентификация через Basic Auth, отдельный ключ интеграции, собственные эндпоинты.

## Кому подходит

- Роль: Разработчик
- Уровень: Опытный

## Что это

**API 2FA Service** — интерфейс для интеграции 2FA с вашим сайтом или сервисом через раздел **2FA Service**. В отличие от OMNI API, этот API:

- Использует **отдельный ключ интеграции** — он выдаётся в разделе 2FA Service и не связан с общим API-ключом из «API Подключения».
- Аутентифицируется через **Basic Auth** — не через заголовок `X-API-Key`.
- Работает с **URL интеграции** — он выдаётся при настройке и может отличаться от базового URL OMNI API.
- Имеет **собственные эндпоинты** для отправки, проверки кода и статуса запроса.

## Чем отличается от OMNI API

| Параметр | OMNI API | API 2FA Service |
|---|---|---|
| **Аутентификация** | Заголовок `X-API-Key` | Basic Auth |
| **Ключ** | Общий API-ключ из раздела «API Подключения» | Отдельный ключ интеграции из 2FA Service |
| **URL для отправки** | `https://web.otpcod.ru/api/v1/messages` | URL интеграции из настроек 2FA Service |
| **Проверка кода** | — | `POST /api/v1/2fa/verify` |
| **Статус запроса** | `GET /api/v1/edrs` | `GET /api/v1/2fa/requests/{requestId}` |

<Tip>
**Тестовое подключение бесплатно** — договор не требуется, мы предоставляем баланс для тестирования.

[Начните с быстрого старта →](https://iba-platform.jamdesk.app/02-otp/00-start-here/otp-003-quick-start)
</Tip>

## Перед началом

- [ ] У вас есть имя отправителя со статусом **Активно**.
- [ ] У вас создана 2FA-интеграция в разделе **2FA Service**.
- [ ] У вас есть **API-ключ интеграции** и **URL интеграции**.

[Как настроить 2FA-интеграцию →](https://iba-platform.jamdesk.app/02-otp/01-turnkey/otp-102-setup-2fa)

## Цикл работы

API 2FA работает в три шага:

<Steps>
  <Step title="Отправка кода">
    Вы отправляете номер получателя на URL интеграции. Платформа генерирует код, отправляет его через канал и возвращает `requestId`.
  </Step>

  <Step title="Пользователь вводит код">
    Пользователь получает код в SMS или другом канале и вводит его на вашем сайте.
  </Step>

  <Step title="Проверка кода">
    Вы отправляете `requestId` и `code` на `/api/v1/2fa/verify`. Платформа возвращает результат — код верный или нет.
  </Step>
</Steps>

Опционально можно:

- Получать **обратные вызовы** о статусах через вебхук.
- Проверять **статус запроса** по `requestId` в любой момент.

## Методы API

API 2FA включает методы для отправки, проверки и мониторинга.

| Что нужно | Куда идти |
|---|---|
| **Отправка и проверка кода** — curl-примеры, параметры, ответы | [Принцип работы 2FA: на стороне платформы →](https://iba-platform.jamdesk.app/02-otp/01-turnkey/otp-106-platform-side) |
| **Обратные вызовы** — формат данных, статусы, обработка | [Получение обратных вызовов при 2FA →](https://iba-platform.jamdesk.app/02-otp/01-turnkey/otp-108-callbacks) |
| **Проверка статуса запроса** — curl-пример, поля ответа | [Проверка запроса 2FA →](https://iba-platform.jamdesk.app/02-otp/01-turnkey/otp-109-check-request) |

## Если нужна генерация на своей стороне

API 2FA Service работает **только с режимом «На стороне платформы»** — платформа сама генерирует и проверяет код.

Если вам нужна генерация и проверка кода на своей стороне — используйте режим **Умный шлюз**.

[Как работает умный шлюз →](https://iba-platform.jamdesk.app/02-otp/02-smart-gateway/otp-201-how-gateway-works)

## Результат

Вы понимаете, чем API 2FA отличается от OMNI API, и знаете, куда идти за деталями по каждому методу.

## Частые проблемы

<AccordionGroup>

<Accordion title="Ошибка 401 Unauthorized">
**Причина:** неверный API-ключ интеграции или неверная схема аутентификации.

**Решение:** проверьте, что используете **Basic Auth** с ключом интеграции из раздела **Данные для интеграции**. Не используйте заголовок `X-API-Key` — он не подходит для 2FA-эндпоинтов.

[Принцип работы 2FA: на стороне платформы →](https://iba-platform.jamdesk.app/02-otp/01-turnkey/otp-106-platform-side)
</Accordion>

<Accordion title="Не приходит код">
**Причина:** номер получателя недоступен или имя отправителя неактивно.

**Решение:** проверьте номер и статус имени отправителя.

[OTP: код не приходит →](https://iba-platform.jamdesk.app/06-reference/03-troubleshooting/ts-otp-code)
</Accordion>

<Accordion title="Проверка кода не работает">
**Причина:** неверный `requestId` или `code`, или истёк срок действия кода.

**Решение:** убедитесь, что `requestId` получен из ответа на отправку, а `code` — тот, который ввёл пользователь.

[Проверка 2FA-запроса →](https://iba-platform.jamdesk.app/02-otp/01-turnkey/otp-109-check-request)
</Accordion>

<Accordion title="Нужна генерация кода на своей стороне">
**Причина:** API 2FA Service работает только с генерацией на стороне платформы.

**Решение:** используйте режим **Умный шлюз**.

[Как работает умный шлюз →](https://iba-platform.jamdesk.app/02-otp/02-smart-gateway/otp-201-how-gateway-works)
</Accordion>

</AccordionGroup>

## См. также

<Columns cols={2}>
  <Card title="Как настроить 2FA-интеграцию" icon="shield-halved" href="/02-otp/01-turnkey/otp-102-setup-2fa">
    Создание интеграции в разделе 2FA Service
  </Card>
  <Card title="Принцип работы 2FA: на стороне платформы" icon="server" href="/02-otp/01-turnkey/otp-106-platform-side">
    Curl-примеры отправки и проверки
  </Card>
  <Card title="Получение обратных вызовов" icon="webhook" href="/02-otp/01-turnkey/otp-108-callbacks">
    Формат данных и обработка вебхуков
  </Card>
  <Card title="Проверка 2FA-запроса" icon="circle-check" href="/02-otp/01-turnkey/otp-109-check-request">
    Статус запроса по requestId
  </Card>
  <Card title="Как редактировать 2FA-интеграцию" icon="pen-to-square" href="/02-otp/01-turnkey/otp-103-edit-2fa">
    Изменение параметров и тестирование
  </Card>
  <Card title="Обработка ошибок API" icon="triangle-exclamation" href="/06-reference/01-api/api-errors">
    HTTP-коды и форматы ответов
  </Card>
</Columns>

## Нужна помощь?

- **OTP-коды:** support@otpcod.ru