开放 API

标准 REST 接口 + 密钥认证，把蓝图AI助手接进你已有的业务系统。
下面是公开的概览：认证方式、限流规则、错误码与核心接口示例。完整字段文档与沙箱密钥可在页面底部申请。

Base URLhttps://<你的实例域名>/api/open/v1

认证

一个请求头就够了

所有接口通过请求头 X-Api-Key 认证，密钥由商务开通后在后台下发。

curl -X GET "https://<你的实例域名>/api/open/v1/health" \
  -H "X-Api-Key: <your-key>"

缺少 X-Api-Key、密钥无效 / 已停用 / 已过期，一律返回 401。
密钥与租户绑定，只能访问自己租户的数据，不存在跨租户读取。
密钥等同口令，请放在服务端调用，不要写进前端代码或小程序包。

限流与配额

每把密钥独立计量

超出限制返回 429，请按指数退避重试。以下四项均可按合作方式单独配置。

调用频率默认 60 次 / 分钟

按密钥独立计算，可按需上调。

总调用量可设上限

用于沙箱密钥或按量合作场景。

有效期可设天数

到期自动失效，适合临时联调。

权限级别可分级

控制密钥能访问的接口与数据范围。

核心接口

当前已开放的接口

这里列出的就是全部已开放接口，没写的即为尚未开放，不做想当然的补全。

查询客户列表

支持分页与关键字检索，返回当前密钥所属租户的客户数据。

GET/customers

curl -G "https://<你的实例域名>/api/open/v1/customers" \
  -H "X-Api-Key: <your-key>" \
  -d "page=1" -d "size=20"

数据回写

让生产系统把状态推回来

除了你来拉数据，也可以由 MES / ERP 主动推送事件进系统。

POST /api/integration/webhook/mes-status已支持

MES 工序状态回写。生产系统在工序流转时推送状态，数据实时落库并驱动项目交付进度与风险预警。

制造业最常用的一条链路，可直接对接现有 MES。

POST /api/integration/webhook/erp-orderBeta·演示态

ERP 订单事件接收。接口已开放并可正常接收推送，返回「已接收，待处理」。

落到具体 ERP 业务字段需要实施期一对一对接，请勿按「已打通」评估工作量。

想知道各类数据源目前支持到哪一步？查看完整数据接入矩阵 →

错误码

出错了先查这张表

200成功请求正常处理，业务结果在响应体中。

400参数错误必填字段缺失或格式不合法，请对照字段说明检查请求体。

401未认证缺少 X-Api-Key，或密钥无效、已停用、已过期。

403无权限密钥的权限级别不允许访问该接口或该数据范围。

404资源不存在路径错误，或指定 ID 的数据不存在 / 不属于当前租户。

429超出限流超过每分钟调用上限或总调用量配额，请退避重试。

500服务端异常服务内部错误，请携带请求时间与参数联系技术支持。

申请

申请完整文档与沙箱密钥

本页是公开概览。完整的字段说明、返回结构、分页规则、Webhook 报文格式，以及可直接联调的沙箱密钥，我们按需下发给正在对接的客户与合作伙伴。

完整接口字段文档（含请求 / 响应示例）
沙箱环境密钥，可直接联调，不影响生产数据
MES / ERP 回写报文格式与字段映射说明
技术对接支持，必要时安排一次联调会

如果你要评估的是私有化部署，先看这篇私有化部署说明。

申请 API 文档 / 沙箱密钥

填写后我们会在 1 个工作日内联系你，确认对接场景并开通沙箱。