跳到主要内容

API 参考

状态

调用模型已实现；可调用的接口清单取决于注册表登记进度（按业务域分批开放）。

调用模型：按接口编码，不做路径镜像​

开放平台不逐条镜像后端路径。全部业务能力经统一直通入口调用：

POST /v1/api/invoke
Headers: Authorization: Bearer oat_xxx   （或 X-App-Key + X-App-Secret）
Body:    { "apiCode": "...", "query": {...}, "body": {...} }

每个开放接口在注册表登记：接口编码、所属业务域、读/写声明、参数语义、是否高危。 未登记或已停用的接口一律拒绝（code=92201）——登记与启用是显式的开放决策。

每次调用经四道闸：注册表存在且启用 → 凭证 scope 覆盖接口的 域:读写 声明 → 绑定员工拥有该接口的主站功能权限（按目标 URL 自动对照员工角色权限，与网关同源、 登记无需配置；无权限拒绝 code=92204）→ 下游业务服务按绑定员工真实身份执行数据权限。 全量调用落审计。

怎么知道有哪些接口​

方式适用
MCP 元工具 list_domains / search_apis / describe_apiAI 客户端自动检索，见工具与能力
开放接口清单人工浏览已开放的接口与调用协议（随批次更新）
接口参考逐接口的请求/响应字段表，由后端接口规格自动生成
向平台管理员索取已启用清单集成商对接（实时权威）

describe_api 返回的 paramsDesc 即接口的参数与枚举语义说明，随登记维护。

版本与变更​

字段级明细页由后端接口规格自动生成，不手工维护——注册表登记的接口一经启用， 其请求/响应字段表即随规格同步产出，见接口参考。

接口版本策略沿用平台的 /v1 前缀 + 公告期约定：接口的新增、变更与废弃， 以及凭证策略与限流规则的调整，都在更新日志发布； 需要调用方配合修改的破坏性变更会提前公告。