API 參考

公開 API 端點供開發人員使用:表單、小工具、產品配置器及其他功能。

呢份參考只描述真實、可公開使用嘅 JSON 端點——包括每個端點嘅方法、路徑、身份驗證類型、必填參數、請求同回應範例,以及已記錄嘅錯誤代碼。Zentor 並冇通用嘅開發者 API 金鑰系統;視乎路由,存取方式係毋須身份驗證,或者透過附帶來源(Origin)檢查嘅 Widget 嵌入權杖。內部儀表板路由同 Master-Admin 端點刻意唔納入呢份公開參考,因為佢哋只可以透過正常登入工作階段存取。

每個端點條目都附有即時測試備註,清楚說明資料來自 Registry 結構、自動化測試,定係實際嘅即時觀察——單純同一條正常運作嘅代碼路徑相似,並唔算完整證明。此外,技術上成功嘅呼叫只確認該請求本身已被處理,並唔自動代表之後嘅程序(例如電郵送達、付款完成或者 SSO 登入完成)都已經成功。

安全保障視乎各個組別而定。公開嘅法律、行銷同表單端點唔需要儀表板工作階段。相反,聊天 Widget 會使用 Header `X-Widget-Token` 同來源(Origin)允許清單。儀表板登入會提供有效期十二小時嘅工作階段 JWT 同有效期七日嘅更新權杖。SSO 端點就使用自己嘅一次性代碼同回呼流程。

請將每個端點頁面當作一份獨立嘅合約嚟睇。關鍵在於 HTTP 方法、路徑、必填參數、資料類型、請求內文、回應結構、錯誤代碼同冪等性。範例只係展示一種可能嘅格式,但唔可以取代對實際回應嘅檢查。設定狀態、驗證、權限同外部供應商都可能改變結果。

已確認嘅全平台速率限制係 15 分鐘內 2,000 個請求。各端點嘅獨立限制並未全部記錄。因此,用戶端唔應該使用不必要地密集嘅輪詢循環。對於非冪等操作,自動重試可能會產生重複嘅資料記錄或者訊息。

敏感數值唔應該出現喺日誌入面,包括密碼、重設權杖、驗證碼、Widget 權杖、工作階段 ID 同真實個人範例資料。請喺文件同測試中使用匿名化數值。即時測試提示必須準確反映實際嘅驗證證據。

認證 (5)登入、Token 更新、密碼重置、SSO 交換公開表單 (11)聯絡、諮詢查詢、存取申請、帳戶啟用。產品配置器 (5)套餐清單、價格預覽、電郵驗證、配置提交公開內容 (6)法律文本、市場推廣頁面、主題及文字顏色設定。聊天小工具 (9)嵌入式聊天小工具在客戶網站上使用的所有端點。示範聊天機器人同 SSO (13)公眾示範聊天機器人同單一登入端點。
← 返回概覽