Swagger UI

Коротко: Swagger UI — интерактивная документация API. Здесь собраны ссылки для всех трёх сервисов платформы.

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

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

Что такое Swagger UI

Swagger UI — это веб-интерфейс, в котором можно:

• Посмотреть все эндпоинты API.
• Изучить параметры каждого запроса.
• Посмотреть примеры ответов.
• Отправить тестовый запрос прямо из браузера.

У каждого сервиса — свой домен и свой Swagger UI. Набор API зависит от сервиса.

OTP-коды

Домен: web.otpcod.ru

• OMNI API — отправка кодов, каскад, справочные методы
• Broadcasts API — рассылки и шаблоны рассылок

Multi API

Домен: web.multiapi.ru

• OMNI API — отправка сообщений, каскад, справочные методы
• Broadcasts API — рассылки и шаблоны рассылок

Мой диалог

Домен: web.mydialogi.ru

• OMNI API — отправка сообщений, каскад
• Broadcasts API — рассылки и шаблоны рассылок
• Recipients API — контакты, атрибуты, фильтры, теги

Как пользоваться

1. Откройте нужную ссылку — Swagger UI откроется в новой вкладке.
2. Найдите эндпоинт — они сгруппированы по тегам.
3. Нажмите на эндпоинт — увидите параметры и примеры.
4. Для тестирования нажмите Try it out — заполните параметры и отправьте запрос.

См. также

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

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