Cobre 持续演进其 API 与产品。当发生变更时,Cobre 会提前通知受影响的客户,以便集成团队能够规划更新,避免措手不及。本指南说明该流程如何运作:变更如何分类、各类型变更提前多久通知、每条通知包含哪些内容、通知通过哪些渠道送达,以及收到通知后团队应如何响应。本指南关注的是变更如何传达以及如何响应——它本身并不介绍新的 endpoint 或对象。请使用本指南规划长期维护 Cobre 集成时的运营侧工作。
变更分类#
并非每种变更对集成的影响相同,因此提前通知的时间取决于变更范围。| 变更类型 | 说明 | 提前通知 |
|---|
| Minor change(次要变更) | 响应或 webhook 中新增字段或附加信息,不影响现有集成。无需采取行动即可继续正常运行。 | 1 至 2 周 |
| Simple change(简单变更) | 可能需要小幅代码更新的小调整,无需重新设计集成。 | 30 天 |
| Medium change(中等变更) | 需要中等程度集成工作的修改,例如流程逻辑变更或 endpoint 使用方式变更。 | 90 天 |
| Major change(重大变更) | 迁移、弃用或不兼容变更,需要在关停日期前重新设计部分集成。 | 180 天 |
提前通知从首次通知起算,至变更生效日期为止——对于迁移,则至旧版本的关停日期为止。通知期从首次沟通起算,而非后续提醒。请依据原始日期规划工作,避免在关停日期临近时才行动。
关键术语#
Advance notice(提前通知):首次通知与变更生效日期(或迁移的关停日期)之间的提前量。
Shutdown date(关停日期):对于迁移与弃用,旧版本或旧行为停止工作的日期。
Breaking change(不兼容变更):需要重新设计部分集成才能继续运行的变更。始终以 Major change 形式传达。
Operational contact / Technical contact(运营联系人 / 技术联系人):接收变更通知的已登记客户联系人,以便双方团队协调实施。
KAM(Key Account Manager,关键客户经理):您指定的 Cobre 账户联系人,可协助实施并解答问题。
每条通知包含的内容#
无论变更类型如何,Cobre 发送的每条通知都会明确说明:变更内容,具备技术精度——确切受影响的字段、endpoint、代码或格式。
变更何时生效——生效日期;涉及迁移时还包括关停日期。
变更是否适用于您以及需要采取的行动,或明确说明无需行动。
通知接收人#
通知将发送给受变更影响客户的所有已登记运营联系人与技术联系人。同时通知两类角色,使双方团队可直接协调实施,而无需依赖组织内部的信息转递。请保持已登记的运营联系人与技术联系人信息最新。变更通知仅发送至您组织记录中的联系人。
沟通渠道#
每条通知通过电子邮件发送至已登记的技术与运营联系人。当变更需要时,docs.cobre.com 上相应的技术文档也会更新以反映该调整。
如何响应通知#
收到通知后,请按以下步骤确认影 响,并在截止日期前安全实施所需变更。1
确认是否适用
说明: 将通知中的条件——受影响的 endpoint、产品或流程——与您集成实际使用的内容进行对照。行动后的预期结果: 明确判断变更是否影响您;若影响,则明确集成中哪些部分在范围内。
2
查阅更新后的文档
说明: 若通知链接至 docs.cobre.com 的某个章节,请查阅以获取实施调整所需的技术细节。行动后的预期结果: 精确理解新字段、endpoint、代码或格式,以及如何调整代码。
3
先在 QA 环境测试
说明: 对于可能影响集成的变更,请先在测试环境验证调整,再部署至生产环境。行动后的预期结果: 在变更影响生产流量之前,确认更新后的集成行为正确。
4
在截止日期前完成实施
说明: 在生效日期或关停日期之前完成所需调整。提前通知的时间已按影响程度设定,但仍请预留余量。行动后的预期结果: 迁移或更新后的集成在变更生效后继续正常运行,无中断。
5
联系您的 KAM
说明: 如有疑问,请联系您的 Key Account Manager(KAM)。也可使用 Cobre 标准支持渠道。行动后的预期结果: 在整个实施过程中获得 Cobre 的支持。
您可期望 Cobre 提供的内容#
每项变更的提前可见性 - 您将收到 minor、simple、medium 与 major 变更的通知,提前量与影响程度成正比——从 1–2 周至 180 天不等。 精确、可执行的通知 - 每条通知明确说明变更内容、生效时间、是否影响您、需采取的行动,以及更新文档的位置。 协调一致的实施 - 由于运营联系人与技术联系人均会收到通知,双方团队可直接协调更新。 有支持的迁移 - 对于不兼容变更与弃用,您有明确的关停日期,并可在旧版本停止工作前获得 KAM 支持完成迁移。