开发者文档
将云动 CPQ 接入你的应用与 AI Agent。使用同一套业务接口完成产品选配、报价、审批、界面定制和企业运营。
当前版本公开记录 274 个 HTTP 操作、9 个 MCP 工具。CLI、MCP 与 OpenAPI 使用相同的操作目录；调用权限由登录账号与服务端业务规则决定。
从你的使用场景开始
| 你要完成的工作 | 阅读入口 |
|---|---|
| 在脚本、终端中查询产品、创建报价或导出文件 | CLI 与 Agent 接入指南 |
| 让 Codex、WorkBuddy 等 Agent 调用 CPQ | MCP 工具与资源 |
| 定制产品配置页或报价工作台 | 界面定制契约 |
| 直接对接 HTTP，查询字段、路径和权限 | 完整 OpenAPI 参考 |
五分钟接入
在已取得的 cpq-app 项目目录安装客户端。CLI 使用 Python 3.11+；MCP 需要安装可选依赖。
python3 -m pip install '.[mcp]'
cpq --base-url http://127.0.0.1:8765 auth login --user 你的登录名
cpq operations list --search quotes
cpq operations describe quotes.list
cpq call quotes.list --query '{"page":1,"pageSize":20}'
密码在终端交互输入。远程部署将示例地址替换为实际 HTTPS 服务地址。SaaS 用户先登录集中账号，再通过 auth enter 进入企业，完整步骤见接入指南。
为已有 Agent 生成当前 Python 环境对应的连接配置：
cpq mcp config --client codex --output codex-cpq.toml
cpq mcp config --client workbuddy --output workbuddy-mcp.json
界面定制的完整流程
- 读取：获得完整目录或报价布局与当前版本。
- 编辑并保存草稿：保留未修改的型号、场景和字段。
- 真实预览：使用已有型号或报价、目标用户检查布局和业务校验结果。
- 发布：按使用者的明确要求发布，并使用最新返回的版本。
- 核对生效：重新读取实际选配结果或报价，确认新布局已使用。
可让 Agent 执行：“读取指定型号的配置页，将‘参数选择’页签改为‘技术参数’，保存草稿并预览，列出校验结果。”报价页通过现有组件与呈现元数据编排；配置页另支持受控的 HTML/CSS/JavaScript 组件。
下载与离线阅读
PDF 包含接入指南、MCP 参数、界面契约和全部 HTTP 操作。配置模板中的路径需要替换；优先使用客户端命令生成适合自己环境的配置。
文档范围
覆盖当前已实现的产品、规则、价格、商务、报价、文件、报告、集成、资产、门户、AI、账号、企业与平台运营接口。平台管理接口列明身份范围，不会因文档公开而取消鉴权。
OpenAPI 列出路由、路径参数、已登记的查询与请求字段、认证及返回约定。复杂目录、规则和布局等仍使用开放 JSON 对象；未列出的嵌套字段由服务端验证。应先读取现有定义，再按最小差异修改。
健康就绪探针、监控指标和浏览器登录跳转属于部署与导航机制，不是 Agent 业务操作。外部厂商连接仍需实际环境联调；WorkBuddy 客户端内的完整交互尚未实测。