Справочник API

Полный справочник REST API, сгенерированный из OpenAPI-спецификации.

Базовый URL

Все эндпоинты доступны по единому базовому URL. Пути в боковой панели (например, /admin/users) — относительные: перед вызовом добавляйте базовый URL и префикс /api.

https://api.voxagent.ru/api

Полный URL запроса = базовый URL + /api + путь из sidebar. Например, запись GET /admin/users из боковой панели фактически:

GET https://api.voxagent.ru/api/admin/users

Аутентификация

API использует аутентификацию через Bearer-токен (Keycloak, OAuth 2.0).

Быстрый токен (для curl / Postman)

Войдите в приложение и откройте https://console.voxagent.ru/token — на странице показан текущий access-токен, готовый к копированию.

curl -X GET https://api.voxagent.ru/api/Users/me \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Своя интеграция

Чтобы вызывать API от имени пользователя из своего приложения, зарегистрируйте OAuth Application и реализуйте Authorization Code + PKCE flow на identity-сервере. Полный гайд — Авторизация.

Эндпоинты

Просмотрите эндпоинты API в боковой навигации.