Обзор API
Единое API IBA Platform — три сервиса, три домена, какие API доступны, ссылки на Swagger UI
Коротко: у 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-ключи.
Подробнее о подключении к конкретному сервису — в статьях:
Swagger UI
Для каждого сервиса доступен свой Swagger UI с описанием эндпоинтов.
OTP-коды
- OMNI API — отправка кодов, каскад, справочные методы
- Broadcasts API — рассылки и шаблоны рассылок
Multi API
- OMNI API — отправка сообщений, каскад, справочные методы
- Broadcasts API — рассылки и шаблоны рассылок
Мой диалог
- OMNI API — отправка сообщений, каскад
- Broadcasts API — рассылки и шаблоны рассылок
- Recipients API — контакты, атрибуты, фильтры, теги
См. также
Нужна помощь?
- OTP-коды: support@otpcod.ru
- Multi API: support@multiapi.ru
- Мой диалог: support@mydialogi.ru