OpenAPI使用规范

一、开放平台公告

开放平台接口会进行正常迭代，对于打破兼容性的情况，我们会通过发公告的方式告知使用者。

对于打废弃标签的接口，将不再接受新的开发需求，已经授权使用的开发者接口仍可继续使用。新客户将无法使用此类接口。建议调整为新版本接口。

对于定时同步数据的情况，接口使用方需通过队列根据开放平台接口限流策略，平稳调用接口。对于循环调用触发限流的情况，不提供调整限流的能力。

异构系统融合对接，接口使用方需建立补偿机制，应对超时、服务波动等引发的数据同步异常。

开放平台部分接口提供幂等能力，防止重复提交生成重复数据。幂等key生成策略建议：https://community.yonyou.com/forum.php?mod=viewthread&tid=221075

对于产生大量异常调用的使用方，生态部门支持人员会优先选择联系使用方确定情况。对于无法联系且给开放平台服务造成严重影响的使用方，将会对其采取限流处理。在配合调整后恢复正常限流。

获取租户所在数据中心域名、获取token等接口，建议做缓存处理。

建议缓存时间：

1、获取租户所在数据中心域名可长久缓存（1个月）

2、token根据返回的有效期进行缓存，剩余半小时有效期可重新获取刷新缓存

对于增量数据同步的情况，优先考虑使用事件订阅

接口使用要和文档保持一致，对于文档描述外的能力，测试部门无法监控。不保证其稳定性。如果有新的需求，文档没有明确说明，请提交工单需求排期。

接口调用要符合客户实际业务需求，项目上线前要进行完整的业务闭环验证。重点关注单据的业务流程，字段回写等。避免引发客户生产环境大量数据异常情况。

双方系统数值类型精度要保持一致。例如：金额、数量、计量单位等等。

YonBIP/YonSuite 公有云 API日志的最大存储时间为14天；事件日志的最大存储时间为7天；如需更长的日志存储，需接口调用方自行记录日志。

目前开放平台接口处于免费状态，后续根据业务发展可能会进行收费。