Базовые URL
Базовые URL трёх сервисов IBA Platform и форматы запросов
Базовые URL
Коротко: у каждого сервиса свой базовый URL. Эндпоинты добавляются к нему. Форматы запросов и ответов одинаковые.
Базовые URL
| Сервис | Базовый URL |
|---|---|
| OTP-коды | https://web.otpcod.ru/api/v1 |
| Multi API | https://web.multiapi.ru/api/v1 |
| Мой диалог | https://web.mydialogi.ru/api/v1 |
Как формируется запрос
Все эндпоинты добавляются к базовому URL. Например:
| Эндпоинт | Полный URL для Multi API |
|---|---|
| POST /messages | https://web.multiapi.ru/api/v1/messages |
| POST /omnimessages | https://web.multiapi.ru/api/v1/omnimessages |
| GET /balance | https://web.multiapi.ru/api/v1/balance |
| GET /channels | https://web.multiapi.ru/api/v1/channels |
Формат запросов
Заголовки
| Заголовок | Значение |
|---|---|
| Content-Type | application/json |
| X-API-Key | Ваш API-ключ |
Методы
| Метод | Что делает |
|---|---|
| POST | Создание сообщения или рассылки |
| GET | Получение данных |
Формат ответов
Все ответы возвращаются в формате JSON.
Успешный ответ
Поля:
- error — false
- data — объект с результатом
Ответ с ошибкой
Поля:
- error — true
- data.message — текст ошибки
- data.requestId — ID запроса для поддержки
Коды ответов
| Код | Значение |
|---|---|
| 200 OK | Успешно |
| 202 Accepted | Принято к обработке |
| 400 Bad Request | Неверные параметры |
| 401 Unauthorized | Неверный API-ключ |
| 404 Not Found | Эндпоинт или ресурс не найден |
| 500 Internal Server Error | Ошибка на стороне сервера |
Подробнее: Обработка ошибок.
См. также
Нужна помощь?
- OTP-коды: support@otpcod.ru
- Multi API: support@multiapi.ru
- Мой диалог: support@mydialogi.ru