从这里开始

版本管理与弃用

了解 URL 主版本、兼容性新增、弃用通知和停用窗口期。

稳定的主版本路径

客户集成在 URL 中使用主版本号,当前为 /api/v1。基于日期的 OpenAPI info.version 标识该主版本内确切的已发布接口约定。

兼容性变更

SendHQ 可能会在 v1 内新增可选的请求字段、响应字段、在结构允许时新增枚举值,以及新增操作。客户端应忽略未知的响应字段,除非结构中明确说明,否则不要把枚举视为永久封闭。

破坏性变更

对请求、响应、身份验证或行为的破坏性变更,需要新的主版本路径(例如 /api/v2)、迁移文档,以及事先公告的过渡期。当前的 v1 API 并未弃用。

弃用与停用

当某个版本被弃用时,SendHQ 会在文档中说明替代方案和迁移路径,并在适用时返回 Deprecation 和 Sunset 响应头。被弃用的版本在公布的弃用日期之后至少还会保留 90 天,除非继续运行会带来紧急的安全或法律风险。