电脑桌面
添加蚂蚁七词文库到电脑桌面
安装后可以在桌面快捷访问

告别API轮询,高效事件集成的终极秘诀都在这儿!

来源:金蝶云社区作者:金蝶2024-09-233

告别API轮询,高效事件集成的终极秘诀都在这儿!

适用版本

该功能适用版本为苍穹V6.0.6以上。


特性展示

工作原理


开放事件(OpenEvent),将金蝶云·苍穹/星瀚的业务单据的变更情况以事件的方式快速触达对接系统,以便对接系统实时做出个性化响应,避免频繁地轮询API。


图 1 工作原理

特性使用指引

| 步骤一:申请灰度许可


开放事件功能作为OpenAPI的一大新特性,目前暂处于试用阶段,首次使用的客户需要申请灰度许可。

路径:【开放服务云】->【OpenAPI】->【开放事件】->【开放事件定义】

打开页面,系统会自动校验当前租户是否拥有灰度许可,若有则打开页面可正常使用,若没有则显示申请灰度许可的弹窗。


图 2 灰度许可申请


点击“申请密钥”按钮,跳转至门户页面,填写申请单信息,提交后等待开放事件管理员线下联系发放密钥。


图 3 许可密钥申请单


拿到密钥信息后,再次前往申请页面,将密钥填写到灰度许可申请弹窗的“许可密钥”字段中。点击“验证密钥”按钮,验证成功后即可使用开放事件功能啦!


| 步骤二:定义开放事件

路径:【开放服务云】->【OpenAPI】->【开放事件】->【开放事件定义】,进入开放事件管理列表页面。


上传图片

图 4 开放事件管理列表


点击“新增”按钮,进入开放事件新增页面。填写事件编码、名称、业务对象、操作等信息,并选择事件需要传递的参数。录入完成保存并启用事件数据。


图 5 新增开放事件


目前支持将平台单据的操作通过零代码配置定义为事件,且支持将多个操作组合定义为一个事件。一旦业务单据进行了相关操作,便会自动触发相应的事件。


| 步骤三:订阅事件

路径:【开放服务云】->【OpenAPI】->【开放事件】->【事件推送订阅】,进入事件推送订阅列表页面。


上传图片

图 6 事件推送订阅管理列表


点击”新增”按钮进入订阅新增页面。配置订阅批号、订阅名称、回调业务方、回调地址,错误重试机制信息,并选择需要订阅的事件,最后保存并发布事件订阅。


回调地址应填写对接系统的Webhook地址,该地址需满足无授权即可访问。在配置过程中,用户可点击”测试”按钮,以验证所配置的回调地址是否符合规范。


图 7 新增事件推送订阅


| 步骤四:查看事件推送日志


当事件被触发时,平台将调用订阅配置的回调地址,以传输变化的业务数据至对接方。推送日志功能记录了推送事件的详细信息,以便用户做日志查询、问题定位、重试补偿等。

路径:【开放服务云】->【OpenAPI】->【开放事件】->【推送日志】

进入推送日志列表,可通过执行时间、实例ID、状态、触发事件编码、触发事件、回调业务方等多字段进行搜索查询事件推送日志。


图 8 推送日志列表


勾选失败状态的日志记录,点击”手工重试”按钮,系统会向回调地址再次推送事件消息,执行完毕后当前日志记录会刷新,展示最新一次推送的详细数据和执行结果。


图 9 手工重推二次确认


点击某条日志记录执行时间,进入日志详情页面,可查看事件推送基本信息、报错日志、推送数据和返回数据等信息。


图 10 推送日志详情


亮点价值

提升异构系统交互实时性:开放事件能够实现几乎实时通信,确

告别API轮询,高效事件集成的终极秘诀都在这儿!

适用版本该功能适用版本为苍穹V6.0.6以上。特性展示工作原理开放事件(OpenEvent),将金蝶云·苍穹/星瀚的业务单据的变更情况以事件的方式...
点击下载文档文档为doc格式

声明:除非特别标注,否则均为本站原创文章,转载时请以链接形式注明文章出处。如若本站内容侵犯了原著者的合法权益,可联系本站删除。

确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息
QQ群
  • 答案:my7c点击这里加入QQ群
支持邮箱
微信
  • 微信