---
title: Базовый URL и аутентификация
description: Базовый URL OTP-сервиса, формат запросов, аутентификация через X-API-Key
---

> **For AI agents:** the complete documentation index is at [llms.txt](/llms.txt). Append `.md` to any page URL for its markdown version.

# Базовый URL и аутентификация

> **Коротко:** все API-запросы к OTP-сервису отправляются на базовый URL с заголовком `X-API-Key`.

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

- Роль: Разработчик
- Уровень: Новичок / Опытный

## Базовый URL

https://web.otpcod.ru/api/v1

Все эндпоинты добавляются к этому 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-ключ](/02-otp/03-for-developers/otp-302-api-key).

## Формат запросов

### Заголовки

| Заголовок | Значение |
|---|---|
| `Content-Type` | `application/json` |
| `X-API-Key` | Ваш API-ключ |

### Методы

OTP-сервис использует стандартные HTTP-методы:

| Метод | Что делает |
|---|---|
| `POST` | Создание сообщения или проверка |
| `GET` | Получение данных (баланс, каналы, EDR) |

## Формат ответов

Все ответы возвращаются в формате JSON.

**Успешный ответ:**

```json
{
  "error": false,
  "data": {
    "channel": 1,
    "transactionId": "1547f4e5-3ca6-4154-bb97-3e4c7e17cedb",
    "messageId": "75bb9087-fc19-4940-a004-c2723337cb2f"
  }
}

Ответ с ошибкой:

json
{
  "error": true,
  "data": {
    "message": "something went wrong",
    "requestId": "af8c5065-5849-455b-ae1a-6a0b9f4b7209"
  }
}

Коды ответов

Код	Значение
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

См. также

Как создать API-ключ
API Reference для OTP
Обработка ошибок API
Нужна помощь?

OTP-коды: support@otpcod.ru