Skip to main content
开放 API 使用日期版本 —— 2026-08-22 是当前(也是创始)版本。当 API 需要破坏性变更(字段改名、响应结构调整)时,变更以一个新日期发布。所有旧版本的行为保持不变。纯新增的变化——新端点、新的可选字段——对所有版本同时生效,不产生新日期。
今天写好的集成会一直收到今天的结构,直到主动切换。这正是这套模型的意义。

密钥绑定版本

每把 API 密钥都绑定到它被创建时的当前版本。不带版本头的请求,按密钥绑定的版本应答。控制台的 API 密钥页面在「API 版本」列展示每把密钥绑定的版本。

按请求覆盖

发送 Orriven-Version 头,可以让单个请求按另一个版本应答——用于在正式切换前试用新版本:
未知的日期返回 400 并列出现存版本。只有已发布的日期有效。

每个响应都包含版本

无论版本由请求头还是密钥的绑定值决定,响应都会回显它:
记录此响应头。升级期间查阅旧日志时,可以看出每条响应当时使用的结构。

升级

1

读变更日志

每个新版本的条目(见下)都从调用方视角写明改了什么。
2

用请求头测试

让预发环境的集成带上 Orriven-Version 指向新日期。密钥的绑定值不受影响,生产流量继续用旧结构。
3

更改绑定

生成一把新密钥(自动绑定最新版本),把集成切换过去,再吊销旧密钥——与任何凭证轮换一样零停机。

变更日志

相关页面

API 密钥

密钥绑定的版本显示位置。

端点参考

当前版本的结构,逐端点列明。