变更记录

1 简介

1.1 功能介绍

提供事件订阅的配置功能。用户使用此功能配置需要监听的开放事件、回调第三方的Webhook地址、及请求签名加密策略。

1.2 面向用户

事件消费者

1.3 应用场景

异构系统监听苍穹业务数据变化情况做出实时响应。

1.4 系统路径

【开放服务云】-【OpenAPI】-【开放事件】-【事件推送订阅】

1.5 关键字段/按钮说明

1.5.1 字段说明

1.5.2 按钮说明

2 主要操作

2.1 查询事件推送订阅

事件推送订阅列表页面展示租户下所有订阅数据，支持按订阅批号和订阅名称做模糊搜索，也支持表头字段做筛选。

2.2 配置事件推送订阅

操作步骤如下：

1、进入事件推送订阅列表，点击“新增”按钮进入新增页面。

2、配置订阅批号、订阅名称、订阅描述等基本信息。

3、配置回调业务方、回调地址、签名策略和签名密钥、加密策略和加密密钥、并设置错误重试机制。

• 回调地址：填写对接系统接收事件消息的接口地址，由对接方提供。地址需满足URL正则规范，且能通过Http/Https + Post能直接调通，对接系统如有防火墙或者IP白名单限制请提前开通。回调接口详细要求请参考： 回调接口要求

• 签名策略：指平台调用回调接口时请求的签名策略。从6.0.13版本后签名策略为必须，用户选择签名策略后，回调接口中需实现对应的验签逻辑。

• 加密策略：指平台调用回调接口时对事件消息进行的加密策略，加密策略为非必须，用户可按需选择。如果用户选择了加密策略，回调接口中需实现对应的解密逻辑方可拿到真实的事件消息。

注意：

1) 签名密钥和加密密钥生成后请线下记录，订阅保存后密钥将加密保存，后续无法查看。

2) 一旦Webhook上线使用，请不要轻易修改签名和加密策略及密钥，否则会导致Webhook验签和解密失败，导致事件传输失败。

4、点击“测试”按钮，测试配置的回调地址是否合规。测试时，系统会向所配置的地址发起一个请求参数为空的POST请求，回调业务方在3秒内返回且不报错即为测试成功。

5、配置订阅事件，点击“新增分录”按钮，选择需要订阅的开放事件，支持一个回调地址订阅多个开放事件。

6、点击“保存”和“发布”按钮，发布成功后订阅配置数据生效。当有对应事件触发时系统会向配置的回调地址推送一条事件消息。

注意：新增事件推送订阅时，默认为“草稿”状态，需发布后才生效。

2.3 撤销事件推送订阅

进入事件推送订阅列表，勾选已发布的数据点击“撤销”按钮，事件推动订阅撤销成功后，事件触发时将不会向对接业务方推送事件消息。

3 注意事项

1、事件推送订阅新增时默认是草稿状态，配置完成后请进行发布操作。

2、事件推送订阅发布前，务必进行回调地址测试，以确保回调地址有效合规。