浏览全部文档

版本管理与弃用

了解我们如何管理 API 版本、发布变更,以及在不兼容变更或移除前发出通知。

API 与 SDK 版本

REST API 版本位于路径中:/v1。没有版本请求头。位于 /mcp 的 MCP 会协商自身的协议版本。

SDK 包版本与 API 版本相互独立。

兼容变更

在 /v1 中,我们可以新增端点、MCP 工具、数据集、国家或覆盖范围,以及保持现有行为的可选输入。这些变更可随时发布,恕不另行通知。

我们也可以不经事先通知,新增可选或可为 null 的响应字段,以及响应枚举中的新值。我们会将这些变更列入更新日志。

客户端应忽略未知字段,并接受未知的枚举值。我们的 SDK 已采用这种处理方式。

不兼容变更

移除字段或更改字段名属于不兼容变更。更改字段的类型、含义、单位、精度或是否必填也属于不兼容变更。

更改路由或方法、身份验证、授权、配额或默认行为也属于不兼容变更。

我们会通过新路径、新操作或新的主版本发布不兼容变更。我们不会悄然更改现有路径、操作或版本。

变更前通知

如果不兼容变更或移除影响到您的账户在过去 90 天内调用过的端点或字段,我们会至少提前 3 个月通知您。我们会通过电子邮件和更新日志通知您。

对于过去 90 天内没有任何账户调用过的端点或字段,我们可能在较短的通知期后移除。我们会在更新日志中公告这些移除事项。

变更公告渠道

我们会在更新日志及其 RSS 订阅源中公告变更。

变更日志 · 更新日志 RSS 订阅源

当前已弃用

经济事件中的 event_type 字段是 type 的已弃用别名。请使用 type。

目前尚未设定移除日期。设定日期时,我们会遵循上述通知政策。