hook配置

# hook配置 ## 01.hook基本概述 > 开发者可以利用hook功能保证扩展业务和开发者平台间的数据一致性,也可以通过自定义逻辑主动拦截平台关键业务事件的执行流程。 > > 开发者可为某个事件绑定自定义HTTP接口地址,平台内部执行此事件时则会先调用绑定的HTTP接口,如果自定义接口不允许本次事件执行,那么该事件将停止执行,并且在前端页面弹出错误消息框,显示开发者返回的拦截消息。 > > 例:(拦截用户登录事件)当用户进行登录操作时,绑定的hook接口接收到此用户信息后不允许该用户登录,则会返回对应的拦截消息。 > > 提示:业务类型为业务平台才可配置hook功能。 ## 02.hook配置重要属性介绍 | 属性名称 | 属性介绍 | |---|---| | 事件类型 | 此属性是平台内具体的业务事件。例: 企业注册、用户登录、审核企业。 | | 回调地址 | 该属性是当指定的事件被执行时调用接口的地址。 | | 超时(ms) | 当执行事件调用接口时,接口响应时间超过此属性时则会触发异常。 | | 异常处理(忽略异常) | 该拦截规则不是很重要时,允许调用该回调地址异常时继续向下执行,忽略异常。 | | 异常处理(回滚报错) | 为了保证系统和扩展业务的数据一致性,遇到异常时则让该事件回滚,该异常包括http连接失败、http读取超时、http非200的状态码、http响应数据不规范等。| | 启用状态 | 该属性决定了当前hook配置是否使用。 | | request-json | 事件触发时的格式示例。当执行事件时调用绑定的HTTP接口会将此数据传入到绑定的接口中,该数据为json 数据(且每个事件数据内容皆有不同) | ## 03.hook配置流程图 ### 3.1.新增hook配置 > 概述:不同的事件请求的参数都为json数据,但是请求参数不同。 *1. 点击添加按钮* ![20220831155736.png](https://cos.easydoc.net/16860085/files/lflv07vs.png) *2. 输入必填参数* (如有疑问请点击-[hook配置属性](#02hook配置重要属性介绍)) ![20220831162016.png](https://cos.easydoc.net/16860085/files/lflv0b5m.png) *3. 点击保存即可完成新增* ![20220831162406.png](https://cos.easydoc.net/16860085/files/lflv0dw6.png) ### 3.2.修改hook配置 *1. 找到您需要修改的 hook配置,并输入新的 hook配置内容* ![20220831163101.png](https://cos.easydoc.net/16860085/files/lflv0gc2.png) ### 3.3.删除hook配置 *1. 找到您需要删除的hook配置,点击删除按钮即可完成删除* ![20220831163611.png](https://cos.easydoc.net/16860085/files/lflv0jr5.png)