Базовый URL и аутентификация
Базовый URL OTP-сервиса, формат запросов, аутентификация через X-API-Key
Базовый URL и аутентификация
Коротко: все API-запросы к OTP-сервису отправляются на базовый URL с заголовком X-API-Key.
Кому подходит
- Роль: Разработчик
- Уровень: Новичок / Опытный
Базовый URL
Все эндпоинты добавляются к этому URL. Например:
- POST /messages → POST https://web.otpcod.ru/api/v1/messages
- POST /omnimessages → POST https://web.otpcod.ru/api/v1/omnimessages
- POST /messages/verification → POST https://web.otpcod.ru/api/v1/messages/verification
Аутентификация
Все запросы требуют заголовок X-API-Key: X-API-Key: ваш-ключ
Как получить ключ: Как создать API-ключ.
Формат запросов
Заголовки
| Заголовок | Значение |
|---|---|
| Content-Type | application/json |
| X-API-Key | Ваш API-ключ |
Методы
OTP-сервис использует стандартные 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:
Открыть Swagger UI: OMNI API для OTP
См. также
Нужна помощь?
- OTP-коды: support@otpcod.ru