# 版本与兼容性

> /v1 中哪些变更不另行通知，哪些会提前 30 天公布，以及在哪里关注更新。

URL: https://developers.vimine.network/zh-hans/guides/versioning/

API 的版本写在路径中（`/v1`），同时还有一个日期：OpenAPI 文档的 `info.version`，即其最近一次变更的日期。每项变更都会在[更新日志](https://developers.vimine.network/zh-hans/news/)中有对应条目。

## 兼容的变更

这类变更在准备就绪后进入 `/v1`，当天即发布对应条目：

- 新的端点、响应中的新字段、请求中新的可选参数或字段；
- 参考文档中标明为开放字符串的新取值（例如 `payment.method`），以及新的错误 `code`；
- 新的权限（scope）和新的语言。

为了让这些变更都不会破坏您的集成：请忽略不认识的字段，把开放字符串中的未知取值当作通用情况处理，并为没有逐一处理的错误 `code` 保留一个默认分支。

Vimine 的页面（登录页、入会表单、活动日程）随时可能调整外观；它们的地址和接受的参数遵循与 API 相同的规则。

## 需要您处理的变更

删除或重命名字段、参数改为必填、响应含义改变：这类变更至少提前 **30 天**公布，会发布一条“需处理”条目，说明要改什么、最晚何时完成，并向开发者账户以及拥有已激活应用的协会负责人发送邮件。变更上线时，会再发布一条条目说明。

在测试期内，这类变更进入 `/v1`。测试期结束后，不兼容的变更将进入新版本 `/v2`，并与 `/v1` 并行至少六个月。

## SDK 和 WordPress 插件

- `@vimine/sdk`：在 0.x 版本期间，补丁版本（0.3.6）绝不会要求您修改代码；次版本（0.4.0）可能会，其条目会说明要改什么。这些条目也收录在软件包的 `CHANGELOG.md` 中。
- WordPress 插件通过 WordPress.org 更新，其插件页面列出相同的条目。

## 关注更新

- [更新日志](https://developers.vimine.network/zh-hans/news/)页面及其 Atom 订阅源，提供门户的每种语言：简体中文为 `/zh-hans/news.xml`，意大利语为 `/news.xml`，依此类推。
- 在 Vimine 控制台中，**开发者**页面会显示最新条目。
- “需处理”条目也会通过邮件发送。