聊天小部件

嵌入聊天小部件在客户网站上使用的所有端点。

该组汇总了嵌入聊天小部件在客户网站上使用的所有公共端点:可用性检查(`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` 请求头,并会额外接受服务器端源允许列表的检查。嵌入令牌在小部件创建时仅一次性以明文显示,严禁出现在公共仓库、支持截图或浏览器日志中。

该组中的每个详情页均单独描述相应端点的方法、路径、身份验证、幂等性以及文档化的错误代码。成功调用一个端点并不自动意味着同一组中的其他端点也调用成功——特别是,绿色的 `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 参考