3. 后台服务API
文件引用:
-
在入口文件中的head中引入js文件
run.work.jssdk.bundle.min.js
-
注:在引入js文件后需要调用
crhReady()
方法进行初始化
1 usertoken校验服务
1.1 基本描述
序号 | 属性 | 定义 |
---|---|---|
1 | 服务编码 | 00290000000012 |
2 | 服务名称 | 润工作后台userToken校验服务 |
3 | 服务功能描述 | 润工作后台userToken校验服务 |
4 | 服务提供方系统 | 润工作后台(commonusertoken) |
5 | 服务提供平台 | ESB |
6 | 请求报文 | SOAP |
1.2.接口描述
请求报文:
序号 | 字段名 | 描述 |
---|---|---|
ESB_ATTRS 系统参数部分 | ESB_SID | 请求方系统编号,由ESB分配 |
ESB_SERVICE_ID | ESB服务编码 | |
ESB_SN | 请求流水, 前四位是系统ID,请求ESB的SID中间14位是时间戳 yyyyMMddHHmmss 后六位是随机数,确保流水号唯一 示例:602120170420140222582394 | |
ESB_USER | 访问ESB用户,由ESB分配 | |
ESB_PWD | 访问ESB用户密码,由ESB分配 | |
REQUEST_DATA业务参数部分 | data | 用户数据(BASE64加密),格式: |
ESB返回报文
S000A000
成功
标记 | 说明 | 备注 |
---|---|---|
returnCode | 返回代码 | S000A000:成功 E0029S99::其它异常,请联系管理员 E0029M02:usertoken,验证失败 |
returnDesc | 返回描述 | 成功 |
2. 获取角色ID服务
2.1.基本描述
序号 | 属性 | 定义 |
---|---|---|
1 | 服务编码 | 00260000000005 |
2 | 服务名称 | 润工作后台角色ID获取接口 |
3 | 服务功能描述 | 润工作后台角色ID获取接口 |
4 | 服务提供方系统 | 润工作后台 |
5 | 服务提供平台 | ESB |
6 | 请求报文 | REST |
2.2.接口描述
请求报文
{
"ESB_ATTRS": {
"ARG_1": "",
"ARG_2": "",
"ARG_3": "",
"ARG_4": "",
"ARG_5": "",
"ESB_PWD": "AC0A5319DBA76463ABB86A39D89E3309",
"ESB_SERVICE_ID": "00260000000005",
"ESB_SID": "0004",
"ESB_SN": "000420161220102558240798",
"ESB_USER": "0004",
"MAC": ""
},
"REQUEST_DATA": "eyJyb2xlTmFtZSI6InN6ZnQifQ=="
}
序号 | 字段名 | 描述 |
---|---|---|
ESB_ATTRS 系统参数部分 | ARG_X | 预留字段 |
ESB_SID | 请求方系统编号,由ESB分配 | |
ESB_SERVICE_ID | ESB服务编码 | |
ESB_SN | 请求流水 | |
ESB_USER | 访问ESB用户,由ESB分配 | |
ESB_PWD | 访问ESB用户密码,由ESB分配 | |
MAC | 备用字段,不传值即可 | |
REQUEST_DATA业务参数部分 | Base64加密 {"roleName":"角色"} 另:在传递报文的时候,需要将BASE64编码中的"\\+"换为"%2B",以解决多出的\的问题。 |
ESB返回报文
{
"RETURN_CODE": "S000A000",
"RETURN_DATA": "eyJyb2xlSWQiOjEzMjV9",
"RETURN_DESC": "success"
}
标记 | 说明 | 备注 |
---|---|---|
RETURN_CODE | 返回代码 | S000A000:成功 ME000FS04:无法找到服务提供方指定位置的资源 ME000FS05:服务提供方异常,不能完成客户的请求 |
returnDesc | 返回描述 | 成功 |
RETURN_DATA | Base64数据,格式: {"roleId":1325} |
3. 给角色添加用户服务
3.1.基本描述
序号 | 属性 | 定义 |
---|---|---|
1 | 服务编码 | 00260000000004 |
2 | 服务名称 | 润工作后台角色添加接口 |
3 | 服务功能描述 | 润工作后台添加角色用户接口 |
4 | 服务提供方系统 | 润工作后台 |
5 | 服务提供平台 | ESB |
6 | 请求报文 | REST |
3.2.接口描述
请求报文
{
"ESB_ATTRS": {
"ARG_1": "",
"ARG_2": "",
"ARG_3": "",
"ARG_4": "",
"ARG_5": "",
"ESB_PWD": "7DCFB6BB9927375B4212CEBC4C194C97",
"ESB_SERVICE_ID": "00260000000004",
"ESB_SID": "0029",
"ESB_SN": "002920161220100455727532",
"ESB_USER": "0029",
"MAC": ""
},
"REQUEST_DATA": "eyJtZW1iZXJzIjoidGVzdDEiLCJyb2xlSWQiOiIxMzE2IiwidHlwZSI6IjAifQ=="
}
序号 | 字段名 | 描述 |
---|---|---|
ESB_ATTRS 系统参数部分 | ARG_X | 预留字段 |
ESB_SID | 请求方系统编号,由ESB分配 | |
ESB_SERVICE_ID | ESB服务编码 | |
ESB_SN | 请求流水 | |
ESB_USER | 访问ESB用户,由ESB分配 | |
ESB_PWD | 访问ESB用户密码,由ESB分配 | |
MAC | 备用字段,不传值即可 | |
REQUEST_DATA业务参数部分 | 参数base64加密,格式: 另:在传递报文的时候,需要将BASE64编码中的"\\+"换为"%2B",以解决多出的\的问题。 |
ESB返回报文
{"RETURN_CODE":"S000A000","RETURN_DATA":"","RETURN_DESC":"success"}
标记 | 说明 | 备注 |
---|---|---|
RETURN_CODE | 返回代码 | S000A000:成功 ME000FS04:无法找到服务提供方指定位置的资源 ME000FS05:服务提供方异常,不能完成客户的请求 |
returnDesc | 返回描述 | 成功 |
4. 应用消息推送服务
4.1.基本描述
序号 | 属性 | 定义 |
---|---|---|
1 | 服务编码 | 00260000000002 |
2 | 服务名称 | 润工作后台IM推送接口 |
3 | 服务功能描述 | 润工作后台IM推送接口 |
4 | 服务提供方系统 | 润工作后台 |
5 | 服务提供平台 | ESB |
6 | 请求报文 | REST |
4.2.接口描述
请求报文
{
"ESB_ATTRS": {
"ARG_1": "",
"ARG_2": "",
"ARG_3": "",
"ARG_4": "",
"ARG_5": "",
"ESB_PWD": "5AE05500201BB9C3D58F13E6A94E19E6",
"ESB_SERVICE_ID": "00260000000002",
"ESB_SID": "6002",
"ESB_SN": "600220161227112158643939",
"ESB_USER": "6002",
"MAC": ""
},
"REQUEST_DATA": "eyJib2R5Ijoi5Yi....24ifQ=="
}
序号 | 字段名 | 描述 |
---|---|---|
ESB_ATTRS 系统参数部分 | MAC | 备用字段,不传值即可 |
ESB_SID | 请求方系统编号,由ESB分配 | |
ESB_SERVICE_ID | ESB服务编码 | |
ESB_SN | 请求流水 前四位是系统ID,请求ESB的SID中间14位是时间戳 yyyyMMddHHmmss 后六位是随机数,确保流水号唯一 示例:602120170420140222582394 | |
ESB_USER | 访问ESB用户,由ESB分配 | |
ESB_PWD | 访问ESB用户密码,由ESB分配 | |
ARG_X | 预留字段 | |
REQUEST_DATA业务参数部分 | Base64加密的推送数据 其中from:@前面的标识为应用标识key,由平台给出,sit,uat,prd分别不同;@后面的为域名, sit:apps.rxdev.crc.com.cn uat: apps.rxuat.crc.com.cn prd: apps.run.crc.com.cn 其中to:@前面是ldap账号,后面的是域名 sit:rxdev.crc.com.cn uat:rxuat.crc.com.cn prd:run.crc.com.cn 其他报文含义参考《消息发送接口v3.html》文档 另:在传递报文的时候,需要将BASE64编码中的"\\+"换为"%2B",以解决多出的\的问题。 |
ESB返回报文
{"RETURN_CODE":"S000A000","RETURN_DATA":"","RETURN_DESC":"success"}
标记 | 说明 | 备注 |
---|---|---|
RETURN_CODE | 返回代码 | S000A000:成功 ME000FS04:无法找到服务提供方指定位置的资源 ME000FS05:服务提供方异常,不能完成客户的请求 |
returnDesc | 返回描述 | 成功 |
5. 应用消息角标修改服务
5.1.基本描述
序号 | 属性 | 定义 |
---|---|---|
1 | 服务编码 | 00260000000006 |
2 | 服务名称 | 润工作后台应用角标修改接口 |
3 | 服务功能描述 | 润工作后台应用角标修改接口 |
4 | 服务提供方系统 | 润工作后台 |
5 | 服务提供平台 | ESB |
6 | 请求报文 | REST |
5.2.接口描述
请求报文
{
"ESB_ATTRS": {
"ARG_1": "",
"ARG_2": "",
"ARG_3": "",
"ARG_4": "",
"ARG_5": "",
"ESB_PWD": "AC0A5319DBA76463ABB86A39D89E3309",
"ESB_SERVICE_ID": "00260000000006",
"ESB_SID": "0004",
"ESB_SN": "000420161220104129722208",
"ESB_USER": "0004",
"MAC": ""
},
"REQUEST_DATA": "eyJhcHBrZXkiOiJhZmE3MWU2ZjY1ZWFiM2QyNGQ4NjcxZDk5MjdkOWIzYSIsImJhZGdlIjoiMiIsInVzZXIiOiJ3YW5neWluZzU0In0="
}
序号 | 字段名 | 描述 |
---|---|---|
ESB_ATTRS 系统参数部分 | MAC | 备用字段,不传值即可 |
ESB_SID | 请求方系统编号,由ESB分配 | |
ESB_SERVICE_ID | ESB服务编码 | |
ESB_SN | 请求流水 | |
ESB_USER | 访问ESB用户,由ESB分配 | |
ESB_PWD | 访问ESB用户密码,由ESB分配 | |
ARG_X | 预留字段 | |
REQUEST_DATA业务参数部分 | BASE64加密 appkey:应用标识 badge:应用角标 user:用户标识 另:在传递报文的时候,需要将BASE64编码中的"\\+"换为"%2B",以解决多出的\的问题。 |
ESB返回报文
{"RETURN_CODE":"S000A000","RETURN_DATA":"","RETURN_DESC":"success"}
标记 | 说明 | 备注 |
---|---|---|
RETURN_CODE | 返回代码 | S000A000:成功 ME000FS04:无法找到服务提供方指定位置的资源 ME000FS05:服务提供方异常,不能完成客户的请求 |
returnDesc | 返回描述 | 成功 |