Центр документации API RUSEON Core
RUSEON Core предоставляет полный набор программных интерфейсов (API) для автоматизации, интеграции со сторонними VMS-системами, передачи метаданных видеоаналитики и создания веб-приложений.
1. Обзор протоколов API
| Протокол | Базовый путь | Формат данных | Аутентификация | Сценарий применения |
|---|---|---|---|---|
| REST API | /api/v1/* | JSON | JWT Bearer | Управление камерами, пользователями, тегами, бэкапы |
| WebRTC WHEP | /api/v1/webrtc/whep | SDP (RFC 8866) | Bearer Token / Query | Доставка видео в браузеры с задержкой < 500 мс |
| HLS API | /api/v1/hls/* | m3u8 / MPEG-TS | Опциональный токен | Live и архивный просмотр через HLS |
| API архива | /api/v1/archive/* | JSON и MP4 | JWT Bearer | Навигация по таймлайну, выгрузка клипов MP4 |
| gRPC пайплайн | localhost:50051 | Protobuf (v3) | mTLS / Metadata | Передача рамок детекций нейросетей, аналитика |
| Swagger UI | /swagger/index.html | OpenAPI 3.0 | Веб-интерфейс / Bearer | Интерактивное тестирование эндпоинтов |
2. Пример авторизации
Получение токена доступа:
bash
curl -X POST http://localhost:8080/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"username": "admin", "password": "ваш_пароль"}'Ответ сервера:
json
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expires_at": 1786888800,
"user": {
"id": "usr_01",
"username": "admin",
"role": "admin"
}
}Использование полученного токена в последующих запросах:
bash
curl -H "Authorization: Bearer <ТОКЕН>" http://localhost:8080/api/v1/cameras