连接器
连接器触发事件发送接口
接口说明:通过该接口,应用可以进行触发事件连接器的事件的发送,使用场景参考连接器使用说明。请求方式:POST (HTTPS),Content-Type: application/json请求地址:https://apigw-example.domain/v1/connector/trigger/evoke/create?app_token=APP_TOKENquery参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| app_token | 是 | 应用访问TOKEN |
请求数据示例:
{
"orgId":"524288",
"connectorOpenId":"safsm0ew2mfa",
"eventTriggerId":"sdfwer23dfssse",
"data":"{\"name\":\"111\"}"
}
请求参数字段说明:|参数|类型 |必须|说明 | |-----------------|----------|-------------|--------------------------------------------------| | orgId | string | 是 | 组织ID | | connectorOpenId | string | 是 | 连接器ID,开发者中心,连接器管理页获取 | | eventTiggerId | string | 是 | 触发事件ID,开发者中心,连接器管理页获取 | | data | string | 是 | 通知数据的json格式,参考连接器开发中的数据模型中的定义 |
返回参数字段说明:|参数|描述 | |-------------------|-------------------------------------------------------------------------------------| | connectorTriggerEvokeId | 触发事件ID |
返回数据示例:
业务正常返回:
{
"errCode":0 ,
"errMsg":"ok",
"data":{
"connectorTriggerEvokeId":"524288-xxxxxxxx"
}
}
业务异常返回:
{
"errCode": 错误码 ,
"errMsg": 对应的统一错误码描述
}
对应可能的错误码说明:
连接器执行事件回调接口
接口说明:蓝信开放平台会将连接器触发事件通过回调的方式分发到订阅了该触发事件的应用的连接器执行事件回调接口。该接口由执行事件连接器应用实现,接口地址需要注册到执行事件连接器的配置参数中,使用场景参考连接器使用说明。请求方式:POST (HTTPS),Content-Type: application/json请求地址:http(s)://url?timestamp=TIMESTAMP&nonce=NONCE&signature=SIGNATUREquery参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| timestamp | 是 | 触发回调事件的时间戳 |
| nonce | 是 | 一个随机字符串,用于签名计算 |
| siganture | 是 | 计算后的签名,签名计算方式参考消息加解密说明 |
当第三方回调地址是 http/https 的时候 ,请求数据会按照 消息加解密说明 加密成一个字符串):
解密前:
{
"dataEncrypt": "XXXXXXXX"
}
解密后:
{
"dataEncrypt": {
{
"data":"xxxxx"
}
}
请求参数字段说明:|参数|类型 |必须|说明 | |------------------|----------|-------------|------------------------------------------------------------------------------------| | data | string |是 | 连接器触发事件数据模型序列化后的字符串,需要根据连接器触发事件使用的数据模型进行进一步的反序列化后获取相关的业务数据。参考触发事件发送接口 请求参数字段中的data字段 |
返回参数字段说明:
第三方回调服务接口收到请求后需要发送应答响应包。不需要做加密处理。
| 参数 | 描述 |
|---|---|
| errCode | 0: 第三方正确进行接收并且解析正常(包括解密); -1:解密失败 ; -2:计算签名失败 ; -3:数据反序列化失败 ; -4:其他类型错误 |
| errMsg |
返回数据示例:
业务正常返回:
{
"errCode":0 ,
"errMsg":"ok"
}