接口兼容性说明
接口变更时,如果其V版本不变,则云商店保证接口是兼容的,如激活授权码接口V1.0版本,其URI为: POST /api/mkp-openapi-public/global/v1/license/activate,在接口修改时,如果该接口的V版本仍然为V1.0,其URI应该保持不变,接口能够保证是兼容的。如果该接口出现不兼容的变更,则云商店会修改接口的V版本,如新的不兼容接口的URI为: POST /api/mkp-openapi-public/global/v2/license/activate。在未通知接口调用方配合修改并已切换到新V版本的API之前,原V版本的API会继续保持可用。
云商店视以下变更为兼容性变更,请接口调用方保证在出现这些类型的接口变更时,接口调用方能够自动保证兼容。
变更类型 |
说明 |
兼容性建议 |
---|---|---|
请求消息增加可选的输入参数 |
接口的请求消息中增加可选的输入参数。 |
无。 |
响应消息增加返回参数 |
响应消息增加返回对象,原有的返回对象增加属性等。 |
调用方在解析JSON消息时,需要保证JSON解析代码能够自动适配响应消息体内新增返回对象或返回码对象增加属性的情况。 |
增加返回码 |
因为业务场景扩展,接口增加了新的返回码。 |
调用方需要自动处理新增返回码的机制,如将新增错误码按其他错误处理。 |