生涯事件远程API
生涯事件定义触发后的行为,可以选择调用api接口。生涯事件提供远程服务支持,可以使用标准api支持,非标准api可以自定义扩展开发。
标准API
生涯事件动作通过条件触发后,可以调用远程api接口。标准api支持带AppID和SecretID验证格式。请求地址根据业务要求设定,默认是POST方式。参数为固定格式,可以根据标准字段,自由选择定义参数。
对接步骤
1、定义好可访问的接口地址URL,方法为POST方式
2、实现AppID和SecretID校验,需要校验HEADER的字段Signature的MD5签名是否正确。Signature由(AppID+SecretID+Timestamp)字符串经过MD5后生成
3、新建对应的生涯事件和远程服务,设置生涯事件对应的动作api。
4、进行测试,触发对应的生涯规则(如用户信息变化,依据规则配置),生涯会自动调用远程api接口。
标准接口定义示例
标准远程更新用户api接口
请求地址: http://xxxx/updateUser
请求方式: POST
请求类型: application/json;charset=utf-8
功能说明: 更新远程接口用户,具体根据业务定义标准接口
请求头:
参数 | 类型 | 必须 | 说明 | ||
---|---|---|---|---|---|
Timestamp | string | true | 时间戳(北京时间毫秒数)用于校验md5参数 | ||
Signature | string | true | MD5签名。由(AppID+SecretID+Timestamp)字符串经过MD5后生成。附带在SID请求数据中 |
请求参数:
请求参数支持标准定义,可以根据实际需要自由选取和自定义参数名字。
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
metaData | object | true | 字段信息定义 |
└─operationType | string | true | 操作类型有insert(添加) 、delete(删除)、update(更新),表示用户是否修改添加和删除 |
└─XM | string | true | 姓名中文名称 |
└─GJ | string | true | 国籍中文名称 |
└─SFZJLXM | string | true | 身份证件类型中文名称 |
└─...... | string | true | 更多标准字段中文名称 |
userInfo | object | true | 用户信息 |
└─XM | string | true | 姓名 |
└─GJ | string | true | 国籍 |
└─SFZJLXM | string | true | 身份证件类型 |
└─IDCARD | string | true | 身份证件号 |
└─...... | string | true | 更多标准字段(可从页面配置添加) |
请求实例:
请求头:
Timestamp: 1625541543029 Signature: f8736e4fbf211bf85e29ec4923f21c5e
请求体:
{
"metaData":{
"XM":"姓名",
"GJ":"国籍",
"SFZJLXM":"身份证件类型",
"operationType":"insert"
},
"userInfo": {
"XM":"老王",
"GJ":"中国",
"SFZJLXM":"居民身份证",
"IDCARD":"4123559412341234",
...
}
}
响应实例: http state code 200为正常
true
生涯配置如下
1、新增服务信息
2、在远程服务信息下新增对应的接口
新建远程服务
添加具体使用的接口信息
3、新建生涯事件,并选择远程服务里面接口api,作为响应动作
新建生涯事件
配置生涯触发条件
选择对应的远程服务api动作
进行测试
由上图可知,生涯触发方式为姓名发生变更,到用户管理去编辑用户,修改用户的姓名,则可以看到生涯事件被触发,观察定义的接口,看到数据发过来。
非标准api
由于可能不能满足以上的标准接口支持,SID对于非标准化接口支持可扩展开发。通过自定义类和配置,可以选择非标准对接方式。
接口调用失败请查看开发指南-Token与Api调用失败须知