---
title: Обзор API
description: Единое API IBA Platform — три сервиса, три домена, какие API доступны, ссылки на Swagger UI
---

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



> **Коротко:** у IBA Platform единое API. Оно одинаково для трёх сервисов — OTP-коды, Multi API, Мой диалог. Отличаются только домен, набор доступных API и Swagger UI.

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

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

## Что это

IBA Platform предоставляет единый программный интерфейс (API) для отправки сообщений, управления рассылками и работы с получателями.

API используется во всех трёх сервисах платформы:

- **OTP-коды** — сервис подтверждения действий пользователей.
- **Multi API** — сервис интеграции каналов.
- **Мой диалог** — омниканальная платформа для рассылок и диалогов.

Формат запросов, аутентификация и формат ошибок — одинаковые. Отличаются:

- **Домен**, на котором доступно API.
- **Набор API**, доступных в конкретном сервисе.
- **Swagger UI** с описанием эндпоинтов.

## Три группы API

| API | Что делает |
|---|---|
| **OMNI API** | Отправка сообщений: одиночных и каскадных. Работа с шаблонами, балансом, EDR, каналами, именами отправителей |
| **Broadcasts API** | Управление рассылками: запуск, шаблоны рассылок, вебхук статусов |
| **Recipients API** | Управление получателями: контакты, атрибуты, фильтры, теги |

## Что доступно в каждом сервисе

| Сервис | OMNI API | Broadcasts API | Recipients API |
|---|---|---|---|
| OTP-коды | ✅ | ✅ | ❌ |
| Multi API | ✅ | ✅ | ❌ |
| Мой диалог | ✅ | ✅ | ✅ |

## Домены и базовый путь

| Сервис | Домен | Базовый путь |
|---|---|---|
| OTP-коды | `web.otpcod.ru` | `/api/v1` |
| Multi API | `web.multiapi.ru` | `/api/v1` |
| Мой диалог | `web.mydialogi.ru` | `/api/v1` |

Итоговый URL запроса, например для Multi API:

```
https://web.multiapi.ru/api/v1/messages
```

## Аутентификация

Все запросы требуют заголовок `X-API-Key` с вашим API-ключом.

**Как получить ключ:** [API-ключи](https://docs.mydialogi.ru/06-reference/01-api/api-keys).

Подробнее о подключении к конкретному сервису — в статьях:

- [Подключение к API OTP](https://docs.mydialogi.ru/02-otp/08-api/otp-api-connection)
- [Подключение к API Multi API](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-102-api-connection)
- [Подключение к API «Мой диалог»](https://docs.mydialogi.ru/04-mydialogi/09-api/md-api-connection)

## Swagger UI

Для каждого сервиса доступен свой Swagger UI с описанием эндпоинтов.

### OTP-коды

- <a href="https://web.otpcod.ru/api/v1/swagger-ui/index.html?urls.primaryName=OMNI_API" target="_blank" rel="noopener noreferrer">OMNI API</a> — отправка кодов, каскад, справочные методы
- <a href="https://web.otpcod.ru/api/v1/swagger-ui/index.html?urls.primaryName=Broadcasts_API" target="_blank" rel="noopener noreferrer">Broadcasts API</a> — рассылки и шаблоны рассылок

### Multi API

- <a href="https://web.multiapi.ru/api/v1/swagger-ui/index.html?urls.primaryName=OMNI_API" target="_blank" rel="noopener noreferrer">OMNI API</a> — отправка сообщений, каскад, справочные методы
- <a href="https://web.multiapi.ru/api/v1/swagger-ui/index.html?urls.primaryName=Broadcasts_API" target="_blank" rel="noopener noreferrer">Broadcasts API</a> — рассылки и шаблоны рассылок

### Мой диалог

- <a href="https://web.mydialogi.ru/api/v1/swagger-ui/index.html?urls.primaryName=OMNI_API" target="_blank" rel="noopener noreferrer">OMNI API</a> — отправка сообщений, каскад
- <a href="https://web.mydialogi.ru/api/v1/swagger-ui/index.html?urls.primaryName=Broadcasts_API" target="_blank" rel="noopener noreferrer">Broadcasts API</a> — рассылки и шаблоны рассылок
- <a href="https://web.mydialogi.ru/api/v1/swagger-ui/index.html?urls.primaryName=Recipients_API" target="_blank" rel="noopener noreferrer">Recipients API</a> — контакты, атрибуты, фильтры, теги

## См. также

<Columns cols={2}>
  <Card title="API-ключи" icon="key" href="/06-reference/01-api/api-keys">
    Создание и управление ключами доступа
  </Card>
  <Card title="Обработка ошибок API" icon="triangle-exclamation" href="/06-reference/01-api/api-errors">
    HTTP-коды и форматы ответов с ошибкой
  </Card>
  <Card title="Вебхуки" icon="webhook" href="/06-reference/01-api/api-webhooks">
    Статусы сообщений, MO-сообщения, статусы рассылки
  </Card>
  <Card title="API Multi API" icon="plug" href="/03-multiapi/02-api/mapi-101-api-overview">
    Полное описание API Multi API
  </Card>
</Columns>

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

- OTP-коды: support@otpcod.ru
- Multi API: support@multiapi.ru
- Мой диалог: support@mydialogi.ru