回调概述
适用场景
回调适用于需要对用户行为进行同步响应的业务场景,即当用户在 WPS 产品中触发某些操作时,前端加载等待服务端返回响应数据。待服务端返回响应结果时,前端加载完成,并向用户展示返回的响应结果。
在 WPS 365 业务中,回调功能的典型使用场景如下:
- 卡片交互场景:用户点击卡片上的交互组件(比如审批卡片上的同意/拒绝按钮),开发者的服务端将收到按钮的点击回调,并且需要立即响应更新后的卡片内容,给予用户操作反馈(比如把审批状态流转为已审批)。
- 文档处理场景:三方开发者使用 WPS 的在线 office 服务时,WPS侧需要在用户打开或编辑云文档时,通过回调调用开发者服务端,以获取文档内容并展示。
回调与事件的区别
回调与事件相似但又有不同:
相似点:
- 都是WPS开放平台服务器主动向开发者服务器推送数据。
差异点:
- 订阅回调后,开发者服务器需要立即返回响应内容,以反馈用户操作,而事件则不要求返回内容,只需响应
200
即可。 - 回调是同步操作,不提供补推机制。如果你的业务服务器超时未响应,则系统会判断回调失败,并在产品前端展示报错信息。
- 事件是异步操作,开发者只需简单响应 WPS 服务器是否收到事件即可,如开发者未响应,则平台会补推送事件。
如何使用回调
详细可见:接收并处理回调