快速開始
本指南使用 SaaS API 標準流程，帶你快速完成第一條分析鏈路。
前置條件
- 可用的 RTSP 視訊來源
- 一組 API Key（
Authorization: Bearer {API_KEY}） - 設備時間資訊（建議設定
utcOffset）
Step 1：建立 API Key
- 端點：
POST /api/v1/api-keys - 建議最小 scope：
device:write、scene:write、task:write、analytics:read
Step 2：建立設備
- 端點：
POST /api/v1/devices - 最小必要欄位：
name,rtspUrl - 建議同時設定：
plan,utcOffset,schedule
{
"name": "入口攝影機",
"rtspUrl": "rtsp://192.168.1.100:554/stream1",
"plan": "level_02",
"utcOffset": "UTC+8"
}
Step 3：建立場景
- 端點：
POST /api/v1/scenes analysisType目前僅支援queue_analysis- zone 使用 polygon（0~1 座標）
Step 4：啟動分析
- 端點：
POST /api/v1/devices/{deviceId}/analysis/start - 必填：
sceneId
Step 5：查詢數據
- 快照歷史：
GET /api/v1/analytics/snapshots - 滾動統計：
GET /api/v1/analytics/rolling - 最新聚合：
GET /api/v1/analytics/scenes/{id}/latest
Step 6（可選）：即時串流與通知
- SSE：
GET /api/v1/devices/:id/analysis/stream - Webhook：
POST /api/v1/users/me/webhook
常見檢查點
- 啟動分析失敗：先確認設備
online、場景active、配額未超限。 - 時間錯位：確認查詢參數使用 UTC，呈現端再轉為設備當地時間。
- 限流錯誤 (
429)：依Retry-After重試。