版本控制
通常情况下,Marketing API 每次接口请求路径中都要求指定当前请求的版本(API_VERSION),例如:当您需要调用V1.1版本的campaigns/add接口时,请求路径应为 https://api.e.qq.com/v1.1/campaigns/add。API的每一个版本都有其预设的服务可用周期,在版本的可用周期内,我们会确保该版本维持持续稳定的服务,对于无法兼容的升级,我们会在规划的新版本中进行实现,确保演进过程中的API调整不会对已有调用方的应用程序造成影响。
在新版本发布之后不会立即停止旧版本的服务,您使用旧版接口的应用程序还可以继续正常运行直到旧版本下线,我们会预留给旧版调用方一定的时间来进行版本迁移(例如半年,具体预留时间请关注网站通知)。因此,API可能存在多个版本同时提供在线服务的情况,这期间您可以多个版本混用。
版本的发布和下线安排大致示意如下:
Marketing API当前支持版本
版本 | 发布日期 | 停用日期 |
V1.1 | 2018-09-13 | 待定 |
V1.0 | 2017-10-24 | 2019-08-31 |
以下情况会在现有版本做更新,版本号维持不变:
- 新增接口
- 新增可选请求字段
- 新增只读响应字段
- 字段范围扩大(包括新增枚举值)
- 修复Bug
以下情况会在新版本中进行,并引发版本号的变更:
- 修改接口路径
- 下线接口
- 修改接口请求方式
- 新增必填请求字段
- 新增可写响应字段
- 修改字段名
- 字段范围缩小(包括下线枚举值)
- 修改字段类型
- 下线字段
您可以随时通过本文档了解目前API支持的版本情况,或者通过开发者官网的【最新动态】了解API的版本发布和升级信息。建议您在自己的开发者管理中心中开启邮件提醒功能,以便及时收到相关版本升级通知。如下图示意: