聊天小工具

嵌入式聊天小工具在客戶網站上使用的所有端點。

此群組匯集嵌入式聊天小工具在客戶網站上使用的所有公開端點:可達性檢查(`GET /api/public/widget/health`)、讀取公開小工具設定(`GET /api/public/widget/config/:widget_code`),以及訊息傳送與歷史記錄(`POST /api/public/widget/message`、`GET /api/public/widget/history`)。網域核准由 Zentor 在建立小工具時維護;租戶儀表板並無相關設定介面。來源未獲核准時,可能出現錯誤代碼 `WIDGET_ORIGIN_DENIED`。建立小工具只限主管理員執行,租戶則會收到完成的嵌入程式碼。

並無通用的開發者 API 金鑰系統。`health` 與 `config` 無需身份驗證即可存取,因為它們用於在瀏覽器中初始化小工具。相反,`message` 與 `history` 需要 `X-Widget-Token` 標頭,並會額外按伺服器端的 Origin 允許清單檢查。嵌入 Token 只會在建立小工具時以明文顯示一次,不得出現在公開儲存庫、支援截圖或瀏覽器日誌中。

此群組每個詳細頁面會分別說明該端點的方法、路徑、身份驗證、冪等性及已記錄的錯誤代碼。成功呼叫某個端點,並不自動證明同一群組的其他端點亦會成功——特別是,綠色的 `health` 檢查既不能確認小工具有效,亦不能確認來源已獲核准或 AI 供應商可以連接。

已確認的全平台 API 限制為 15 分鐘內 2.000 次請求。只有在某個小工具端點有明確證據時,才會列出與此不同的限制。`message` 並非冪等;用戶端在未確認第一條訊息是否已處理前,不得自動重試不明中斷的傳送。

此群組的技術驗證以 `app/frontend/src/content/api-reference/groups/widget.ts` 的註冊表及相關後端路由為依據。每個詳細頁面都會標明所驗證的是實時成功路徑、負面路徑,抑或只是程式碼類比——此區分適用於整個群組,不得以籠統的成功聲明取代。

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
← API 參考