Базовый URL и аутентификация
Базовый URL Multi API, формат запросов, аутентификация через X-API-Key
Базовый URL и аутентификация
Коротко: все API-запросы к Multi API отправляются на базовый URL с заголовком X-API-Key.
Кому подходит
- Роль: Разработчик
- Уровень: Новичок / Опытный
Базовый URL
https://web.multiapi.ru/api/v1
Все эндпоинты добавляются к этому URL. Например:
- POST /messages — POST https://web.multiapi.ru/api/v1/messages
- POST /omnimessages — POST https://web.multiapi.ru/api/v1/omnimessages
- GET /balance — GET https://web.multiapi.ru/api/v1/balance
Аутентификация
Все запросы требуют заголовок X-API-Key.
Формат заголовка: X-API-Key: ваш-ключ
Как получить ключ: Как создать API-ключ.
Формат запросов
Заголовки
| Заголовок | Значение |
|---|---|
| Content-Type | application/json |
| X-API-Key | Ваш API-ключ |
Методы
Multi API использует стандартные HTTP-методы:
| Метод | Что делает |
|---|---|
| POST | Создание сообщения или рассылки |
| GET | Получение данных (баланс, каналы, EDR) |
Формат ответов
Все ответы возвращаются в формате JSON.
Успешный ответ
Поля:
- error — false
- data.channel — номер канала
- data.transactionId — ID транзакции
- data.messageId — ID сообщения
Ответ с ошибкой
Поля:
- error — true
- data.message — текст ошибки
- data.requestId — ID запроса для поддержки
Коды ответов
| Код | Значение |
|---|---|
| 200 OK | Успешно |
| 202 Accepted | Принято к обработке |
| 400 Bad Request | Неверные параметры |
| 401 Unauthorized | Неверный API-ключ |
| 404 Not Found | Эндпоинт или ресурс не найден |
| 500 Internal Server Error | Ошибка на стороне сервера |
Подробнее: Ошибки API: HTTP-коды.
Ссылки на Swagger UI
Интерактивная документация доступна в Swagger UI:
- OMNI API: https://web.multiapi.ru/api/v1/swagger-ui/index.html?urls.primaryName=OMNI_API
- Broadcasts API: https://web.multiapi.ru/api/v1/swagger-ui/index.html?urls.primaryName=Broadcasts_API
- Recipients API: https://web.multiapi.ru/api/v1/swagger-ui/index.html?urls.primaryName=Recipients_API
См. также
Нужна помощь?
- Multi API: support@multiapi.ru