TS-API Reference

Table of Contents

1. API Versions

2. Quick Start

2.1. Login (JWT)

# JWT login - returns accessToken
# Note: auth = base64("admin:1234"). Use your actual NVR account credentials.
curl -X POST "http://localhost/api/v1/auth/login" \
 -H "Content-Type: application/json" \
 -d '{"auth":"YWRtaW46MTIzNA=="}'
# Response: {"accessToken":"eyJ...","refreshToken":"...","expiresIn":3600,"tokenType":"Bearer"}

2.2. Get Channels

curl "http://localhost/api/v1/channel" \
 -H "Authorization: Bearer {accessToken}"

2.3. PTZ Control

curl "http://localhost/api/v1/channel/1/ptz?home" \
 -H "Authorization: Bearer {accessToken}"

2.4. Alternative: API Key (for integrations)

# Create API Key (admin only - JWT authentication required)
curl -X POST "http://localhost/api/v1/auth/apikey" \
 -H "Authorization: Bearer {accessToken}" \
 -H "Content-Type: application/json" \
 -d '{"name":"Monitoring System"}'
# Use API Key (all v1 endpoints accessible, no login required)
curl "http://localhost/api/v1/channel" \
 -H "X-API-Key: tsapi_key_..."

3. Documentation

4. Endpoint Summary

4.1. v1 REST API Endpoints

4.1.1. Authentication

4.1.2. Server Info

4.1.3. System

4.1.4. Channel

4.1.5. Recording

4.1.6. Event

4.1.7. LPR (License Plate Recognition)

4.1.8. Object Detection

4.1.9. Face Search

4.1.10. VOD (Video on Demand)

4.1.11. Other

4.2. v1 WebSocket Endpoints

5. Response Format

5.1. Array Response (channels, status, event types, etc.)

[
 {"chid": 1, "title": "Front Door"},
 {"chid": 2, "title": "Parking Lot"}
]

5.2. Paginated List Response (event logs, LPR logs, object search)

{
 "totalCount": 100,
 "at": 0,
 "data": [ ... ]
}

5.3. Error Response

{
 "code": -1,
 "message": "Error description"
}

6. HTTP Status Codes

7. License-dependent Features

8. WebSocket API

8.1. WebSocket Authentication

// JWT (query param)
const ws = new WebSocket('ws://server:port/wsapi/v1/events?topics=LPR&token={accessToken}');
// API Key (query param)
const ws = new WebSocket('ws://server:port/wsapi/v1/events?topics=LPR&apikey=tsapi_key_...');

8.2. Event Subscription Example

const ws = new WebSocket('ws://server/wsapi/v1/events?topics=LPR,channelStatus&apikey=tsapi_key_...');
ws.onmessage = (e) => {
 const data = JSON.parse(e.data);
 console.log('Event:', data);
};