跳转至

开发者文档

开发者文档面向需要生成、读取或对接 GhostClickAI 公开数据的开发者。普通用户创建蓝图和宏不需要阅读本章。

当前公开内容

  • GCBPS API:外部运行 API 的认证、请求、响应与安全约定。
  • GT4AI AI 使用手册:当前本机会话、工作流编辑边界、真实验证及单文件技能下载;先探测安装版本的能力。
  • 自定义 Python 与 gcbppy:端口与类型、媒体、受管 worker 及脚本信任边界。

后续只有已经公开并适合第三方使用的文件或接口才会进入这一部分。桌面软件的内部进程、服务调度、私有通信协议、服务器路径和运维凭据不属于公开 API。

版本与兼容性

  • 开发版接口可能随产品结构调整,页面会写明适用版本和状态。
  • 字段是否可选、默认值和错误码以对应接口页面为准。
  • 未在开发者文档中声明的字段不应作为稳定集成依据。
  • 导入数据时应保留未知但允许透传的字段,不要依赖字段排列顺序。
  • 在正式数据上启用新集成前,先使用独立测试自动化验证导入、保存、运行和再次导出。

安全原则

  1. 不把账号密码、访问令牌或管理凭据写入蓝图和示例代码。
  2. 不把用户文件直接发送到未说明的第三方服务。
  3. 对导入文件执行大小、类型和结构检查。
  4. 外部自动化可能包含自定义节点或有副作用的操作,运行前应向用户说明并获得信任。
  5. 文档中的示例值只用于说明格式,不能作为生产凭据。

用户手册与开发者文档的边界

如果你的目标是使用界面创建自动化,请返回使用手册。如果你的目标是理解某个节点,请使用节点参考。开发者文档只负责公开数据与集成契约,不重复解释每个界面按钮。