跳到正文

Automation API ​

每条规则由一个事件源、可选查询、AND/OR 条件和 1 到 8 个顺序执行的动作组成。接口参考对应 OpenAPI 文档版本 6.0.0。

服务地址 ​

使用部署方提供的 Automation 服务地址。源规范使用相对服务地址 /,路由不带版本前缀,也未指定生产域名。在接口参考中发送请求前,请在「服务器」区域填写包含 https:// 或 http:// 的完整服务地址。浏览器会在 Automation 接口之间保留该地址。

下载 OpenAPI JSON。

认证 ​

业务接口要求在 CP-X-API-KEY 请求头中提供具有 automation scope 的 Key。只有健康检查和 CORS 预检允许匿名访问。

规则和历史记录归属于认证返回的 Owner。同一 Owner 的 Key 共享普通管理权限;exec 还要求 Key ID 在服务端允许列表中。通过 GET /me 查看当前身份。

规则定义 ​

字段用途
source只能有一个来源:cron、incoming 或 price。价格条件从不满足变为满足时产生事件,首次报价只建立基线。
queries最多 8 个具名查询,为事件补充数据,自身不触发执行。目前支持 price。
filters可选的 AND/OR 表达式,支持 text_contains 和 number_compare,读取 /data/... 和 /queries/<id>/...。
actions1 到 8 个按顺序执行的 webhook 或 exec 动作。不接受单数形式的 action。
cooldown_minutes默认 0。冷却窗口内的事件会被跳过。
note可选备注。仅修改备注不会增加规则 revision。

价格来源和查询需要服务端配置 Oracle;exec 仅在 Linux/macOS 上对允许的 Key ID 开放。GET /types 返回当前 Key 可用的类型。X 和邮件类型尚未实现。

接口入口 ​