RUSEON Core API Documentation Hub
RUSEON Core provides a developer-friendly API suite designed for programmatic automation, third-party VMS integrations, AI computer vision pipelines, and web dashboards.
1. API Protocols Overview
| Protocol | Base Endpoint | Data Format | Authentication | Primary Use Case |
|---|---|---|---|---|
| REST API | /api/v1/* | JSON | JWT Bearer | Camera CRUD, Users, Tags, Backups, Health |
| WebRTC WHEP | /api/v1/webrtc/whep | SDP (RFC 8866) | Bearer Token / Query | Ultra-low latency (<500ms) browser video |
| HLS API | /api/v1/hls/* | m3u8 / MPEG-TS | Optional Token | Live & timeshift video streaming |
| Archive API | /api/v1/archive/* | JSON & MP4 | JWT Bearer | Historical timeline, segments, MP4 exports |
| gRPC Pipeline | localhost:50051 | Protobuf (v3) | mTLS / Metadata | AI bounding boxes, analytics, event streams |
| Swagger UI | /swagger/index.html | OpenAPI 3.0 | Web UI / Bearer | Interactive API testing and discovery |
2. Quick Authentication Example
Obtain an access token:
bash
curl -X POST http://localhost:8080/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"username": "admin", "password": "your_password"}'Response:
json
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expires_at": 1786888800,
"user": {
"id": "usr_01",
"username": "admin",
"role": "admin"
}
}Use the token in subsequent API requests:
bash
curl -H "Authorization: Bearer <TOKEN>" http://localhost:8080/api/v1/cameras