5.4.4.13 链码事件注册接口
可以通过该接口注册FISCO BCOS的出块事件或者合约事件,当事件被触发时,系统将向注册的通知地址发送事件内容。
1. 接口地址: https://节点网关地址/api/fiscobcos/v1/event/register
2. 通讯方式: POST
3. 签名算法:详见5.4.4.1 应用接入签名算法
4. 请求参数
序号 | 字段名 | 字段 | 类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | 信息头 | header | Map | 是 | |
2 | 信息体 | body | Map | 是 | |
3 | 签名值 | mac | String | 是 | |
header: | |||||
1 | 用户唯一标识 | userCode | String | 是 | |
2 | 应用唯一标识 | appCode | String | 是 | |
body: | |||||
1 | 事件类型 | eventType | String | 是 | 1:出块事件;2:合约事件 |
2 | 合约地址 | contractAddress | String | 否 | EventType为1时可以为空,为2时,不可与contractName同时为空 |
3 | 合约名 | contractName | String | 否 | EventType为1时可以为空,为2时,不可与contractAddress同时为空 |
4 | 通知地址 | notifyUrl | String | 是 | |
5 | 附件参数 | attachArgs | String | 否 |
示例
{
"header":
{
"userCode":"USER0001202006042321579692440","appCode":"app0001202006042323057101002","tId":""
},
"mac":"MEUCIQCMP1ToZS5e8S94kYZ/8y5XfeyjRyUrPFpeIQMES3SGpQIgO8b6O8Kk/qpNTo1vbNTwyAYNaw6HBi9OkAH8Rp23j8s=",
"body":
{
"eventType":1,"contractAddress":"0x866aefc204b8f8fdc3e45b908fd43d76667d7f76","contractName":"BsnBaseContractk1","notifyUrl":"http://127.0.0.1:18080","attachArgs":"abc=123"
}
}
5. 响应参数
序号 | 字段名 | 字段 | 类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | 信息头 | header | Map | 是 | |
2 | 信息体 | body | Map | 是 | |
3 | 签名值 | mac | String | 是 | |
header: | |||||
1 | 响应标识 | code | int | 是 | 0:校验成功 -1:校验失败 |
2 | 响应信息 | msg | String | 否 | code=0 时可为 null |
body: | |||||
1 | 事件Id | eventId | string | 是 | code 不为 0 时为空 |
示例
{
"header":
{
"code": 0,
"msg": "处理成功"
},
"mac": "MEUCIQCMFbVhfH9X8pJ1mNI3YpzKIBcXCpfmf2AniF/42ak9EwIgTWDEF+xW5l39ZDUnDSSSc8Zv8J1glEf9izp16eW/Rn4=",
"body":
{
"eventId": "xxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}