SaaS 文件

依據 docs/SaaS-API.md v0.10.0 更新

API 版本: v1
最後更新: 2026-02-25

使用順序

1. 認證：建立 API Key
2. 設備：建立設備（RTSP）+ 排程
3. 場景：建立 queue_analysis 場景
4. 告警：建立規則與通知
5. 控制：啟動/停止分析
6. 數據：查詢 snapshots / rolling / insights / attributes
7. 即時串流：SSE（可選）
8. Webhook：接收事件通知
9. Billing Dashboard：配額/趨勢/預測
10. Usage API：user/device 用量
11. Admin 配額管理：管理員增額

重要時間規則

• 規則與排程使用設備當地時間（由 device.utcOffset 決定）。
• 查詢 API 的 startDate / endDate 參數使用 UTC。
• nextScheduledAt 以 UTC 儲存，供排程執行器比對。

統一回應格式

{
	"success": true,
	"statusCode": 200,
	"message": "Operation completed successfully",
	"data": {},
	"meta": {
		"timestamp": "2026-01-29T10:00:00.000Z",
		"requestId": "req-uuid"
	}
}

主要文件入口

• 快速開始
• API 總覽
• Billing Dashboard API
• Usage API
• Admin 配額管理 API
• 指標路徑
• 錯誤碼參考
• 版本變更紀錄