系统设置与帮助文档
每个工作台页面右上角的「帮助」打开抽屉,可在保留当前表单的情况下阅读。已配有专题的页面直接打开对应说明,其余页面打开可搜索目录。也可从门户进入独立文档中心,复制文章地址分享给接入人员,无需登录。
配置外部 Wiki
拥有 settings:write 权限的管理员,在「系统设置 → 基础设置」填写「外部帮助文档 / Wiki 地址」,点击系统设置表单的保存按钮。地址必须是完整 HTTP(S) URL,不允许 javascript、data、嵌入账号密码的 URL 或相对路径。建议使用 HTTPS,留空即可移除。
保存后重新打开帮助或刷新文档中心即可看到「外部帮助 / Wiki」。这是对所有访客公开的链接,请填写可公开分享的入口,不要包含访问令牌或私有凭据。访问受限的 Wiki 仍由其自身执行登录鉴权。
内置文档随应用版本发布。外部 Wiki 只作为补充,在新标签打开,不会取代内置帮助;外部服务故障不影响内置文档。后端不可用时仍可阅读内置文档,并显示无法获取外部链接的提示。
系统配置与诊断
系统设置的更改仅在保存成功后生效。注册邮箱验证依赖有效 SMTP 配置;修改之前先阅读注册与邮件配置。运行首次运行自检可查看服务连接和配置缺失;自检通过不等于真实支付/发信渠道验收完成。
给接入开发者与 AI 的文档
- 应用登录与用户字段映射:先确定真正要填入的字段。
- 登录与授权接口参考:认证、请求、响应与错误。
- 机器版本接口参考:流水线发布协议。
- AI 文档索引:同源 Markdown 和 OpenAPI 下载入口,无需页面抓取或运行 JavaScript。
机器可读契约当前覆盖登录、应用授权和机器发布;其他功能指南不等于完整接口契约。以当前部署内置文档为准,外部 Wiki 可能对应不同版本。