API 快速入門
確認連線並讀取事件
準備 Watch 顯示的 API 網址和有事件讀取權限的 API 金鑰。從能連到 Watch 的電腦執行以下步驟,即可驗證連線,不需要先接攝影機或安裝 SDK。
1. 取得網址與金鑰
Watch 桌面版
- 開啟「設定 → API 與整合 → 連線設定」。若從另一台裝置連線,開啟區域網路 API,選擇該裝置所在的受信任網路。
- 複製介面顯示的 API 網址。建立讀取事件用的 API 金鑰,把只顯示一次的完整金鑰保存在本機。
- 想先不用終端機測試?在允許的區域網路裝置開啟 Watch 顯示、結尾為 /viewer/ 的事件檢視器網址。核對瀏覽器位址確實屬於你的 Watch 主機,才在密碼欄位貼上金鑰並按「連線」。看到「已連線」即可;近五小時沒有事件也能連線成功。
桌面 LAN 提供唯讀事件與可用證據。攝影機、監控設定與離線工作請在 Watch 內管理。 v0.39 事件與證據參考
若由管理員提供既有事件 API,使用他提供的實際網址與 events:read 金鑰即可,不需要額外安裝服務。
2. 用終端機確認服務可連線
如果檢視器顯示「已連線」,你已完成第一個事件讀取測試。若要驗證程式整合,複製 Watch 提供的 API 根網址(不含 /viewer/ 與結尾斜線)。請從預計執行整合的電腦測試。若整合在另一台主機上,localhost 會指向那台主機。
macOS / Linux
WATCH_URL='http://YOUR_WATCH_IP:PORT'
curl -q --noproxy '*' -sS --max-time 10 -o /dev/null -w 'Health HTTP %{http_code}\n' "$WATCH_URL/healthz"Windows PowerShell
$WatchUrl = 'http://YOUR_WATCH_IP:PORT'
(Invoke-WebRequest -UseBasicParsing -MaximumRedirection 0 -TimeoutSec 10 -Uri "$WatchUrl/healthz").StatusCode200 代表服務有回應。連線失敗時,核對網址、連接埠與所選網路,再檢查 Watch 是否保持開啟。
3. 以唯讀方式查詢事件
使用本機的密鑰管理工具將金鑰載入 WATCH_API_KEY 環境變數,再執行下列一個範例。這些檢查只顯示 HTTP 狀態,不會列出事件內容。請只將金鑰傳到剛才核對的 Watch 網址。
macOS / Linux
curl -q --noproxy '*' -sS --max-time 10 -o /dev/null -w 'Events HTTP %{http_code}\n' \
-H "Authorization: Bearer $WATCH_API_KEY" "$WATCH_URL/v1/events?limit=1"Windows PowerShell
$Headers = @{ Authorization = "Bearer $env:WATCH_API_KEY" }
(Invoke-WebRequest -UseBasicParsing -MaximumRedirection 0 -TimeoutSec 10 -Headers $Headers -Uri "$WatchUrl/v1/events?limit=1").StatusCode200 代表此金鑰可以讀取事件,即使目前沒有事件。401 時在 Watch 本機檢查金鑰是否完整或已撤銷。403 時請管理員確認金鑰的事件讀取權限及用戶端是否位於允許的網路。
完成這裡只確認事件讀取可用。設定、任務、排程與資料庫操作仍在 Watch 介面完成,公開 API 不提供這些寫入功能。