Watch 0.39 API v1

讀取 Watch 事件與串接系統

身分驗證

取得事件讀取金鑰

讀取事件、串流和截圖需要 events:read API 金鑰。網站登入、產品授權與這組金鑰用途不同。

1. 在 Watch 建立金鑰

  1. 在 Watch 開啟「API 與整合 → 連線設定」,確認區域網路連線已開啟,並選擇整合電腦所在的網路。
  2. 在「連線金鑰」按「建立 API Key」。若無法操作,請本機管理員協助。
  3. 複製只顯示一次的完整金鑰,保存在本機密鑰管理工具或整合系統的密鑰儲存區。介面會顯示到期時間。

若由管理員提供既有事件 API,請向他取得實際網址與事件讀取金鑰。不需要另外部署服務,也不需要管理員權限的 API 金鑰。

2. 確認能讀取事件

在 Watch 提供的內建事件檢視器輸入金鑰。顯示已連線,即代表驗證成功;事件列表為空也屬正常。程式整合請在每個請求加入以下標頭,金鑰不要放在網址。

Authorization: Bearer <event-read-api-key>

依快速入門完成連線測試

連線失敗時

  • 401:在本機核對金鑰是否完整、已到期或遭撤銷。
  • 403:請管理員確認 events:read 權限,以及整合電腦是否在允許的區域網路。
  • 404:先核對 API 路徑。更換成高權限金鑰不會增加唯讀入口的功能。

更換或撤銷金鑰

在同一個「連線金鑰」區域建立替代金鑰,更新整合系統並完成讀取測試,再將舊金鑰「停用並刪除」。若金鑰已外洩,請先停用。這些管理操作在 Watch 本機完成,公開事件 API 不提供金鑰管理。

撤銷或過期後,下一個事件或圖片請求會重新驗證。SSE 連線則會在下一次權限檢查時關閉,未必立即中斷。收到 401 或 403 後,停止使用該金鑰重試並請管理員確認。

只把金鑰交給你信任的 Watch 網址、內建檢視器或本機工具。不要貼入聊天、支援紀錄、第三方網頁或程式原始碼。/healthz 與 OpenAPI 文件不需要金鑰。