Введение в API — API

Главная / Документация / APIВведение в APIКак устроено API volrix.pm: база /api/v1, домены, Swagger как полный справочник.Обновлено 24.06.20261. НазначениеРаздел вводит разработчика в API системы: где находится API, как он версионируется, как аутентифицироваться и как устроены ответы. API построен на FastAPI и отдает JSON.2. Базовый адрес и версионированиеВсе эндпоинты API имеют префикс `/api/v1`. Версия зафиксирована в пути (`v1`).3. Интерактивная документацияИнтерактивная документация (OpenAPI) публикуется только при включенном параметре `EXPOSE_API_DOCS`:

Swagger UI: `/api/docs`

ReDoc: `/api/redoc`

Схема OpenAPI: `/api/openapi.json`

Если параметр выключен (значение по умолчанию), эти адреса недоступны.4. Форматы и пагинацияЗапросы и ответы - в формате JSON. Списочные эндпоинты используют постраничную выдачу: параметры `page` (по умолчанию 1) и `page_size` (по умолчанию 20); в ответе возвращаются `total`, `page`, `page_size`, `pages` и список элементов.5. Способы аутентификацииAPI поддерживает два способа (см. `dev-auth`):

**JWT** для пользовательских сессий - токен в заголовке `Authorization: Bearer <token>`.

**API-ключ** для интеграций - заголовок `X-Api-Key: <ключ>`.

Права проверяются по тем же парам "коллекция - действие", что и в ролевой модели; у API-ключа набор разрешений (scopes) задается при создании.6. Связи с другими разделами

**Аутентификация и API-ключи** (`dev-auth`): получение токена и работа с ключами.

**Интеграции** (`admin-integrations`): выпуск и отзыв API-ключей.

**Роли и доступы** (`admin-roles`): модель прав, общая для UI и API.

Документация соответствует версии продукта 0.9.0. Дата проверки: 2026-06-23.

Интеграции и REST API

Функциональная карта