银联商务RPA

Appearance

接口文档 ​

环境地址 ​

环境url
测试环境https://rpaservice-test.chinaums.com/rpa-console
生产环境（银商版）https://rpaservice.chinaums.com/rpa-console
生产环境（企业版）https://rpaservice.chinaums.com/ums-console

鉴权相关接口 ​

accessToken获取接口 ​

接口url：/api/getAccessToken

HTTP Method : POST JSON

请求参数:

参数名称参数说明是否必须数据类型
appIdappIdtruestring
appSecretappSecrettruestring
timestamp时间戳（例如：1692341625440）truestring
signature签名，sha256(appId+appSecret+timestamp)truestring

响应参数:

参数名称参数说明类型
code0-成功，1-失败int
data返回数据，data.accessToken字段数据为平台生产的token数据object
msg返回消息string

注：token有效期为2小时

响应体示例

json
{
  "data": {
    "accessToken": "520da9c9-694d-4b40-9332-0c179243c88e",
    "expires": 7199
  },
  "code": 0,
  "msg": "success"
}

工作流相关接口 ​

工作流数据修改接口 ​

url：/api/task/update

HTTP Method : POST JSON

请求头:

参数名称参数说明是否必须数据类型
accessToken鉴权接口获取的accessTokentrueString
Content-Typeapplication/jsontruestring

请求参数:

参数名称参数说明是否必须数据类型
workflowIdworkflowIdtruelong
cron定时启动表达式（如果不用修改请带上原来的值）falsestring
qywxRoburl企业微信群发url（如果不用修改请带上原来的值）Falsestring
autoWorkStatistics是否自动统计工时（0代表否，1代表是）FalseInt
workTime单笔节省工时Falsedouble

响应参数:

参数名称参数说明类型
code0-成功，1-失败int
msg返回消息string

响应体示例

json
{
  "code": 0,
  "msg": "success"
}

查询工作流列表接口 ​

url：/api/task/list

HTTP Method : POST JSON

请求头:

参数名称参数说明是否必须数据类型
accessToken鉴权接口获取的accessTokentrueString

请求参数:

参数名称参数说明是否必须数据类型
taskName工作流名称Falsestring
machineCode机器码Falsestring
projectName项目名称Falsestring
page分页之第几页，默认值1falseInt
pageSize分页之每页多少条，默认值10Falseint

响应参数:

参数名称参数说明类型
code0-成功int
msg返回消息string
data返回数据Object

data数据说明：

参数名称参数说明类型
curPage当前页页码int
pageSize分页之每页多少条int
list列表数据List
totalCount数据总量int
totalPage页数总量int

list数据说明

参数名称参数说明类型
taskIdtaskIdint
taskName工作流名称string
cron定时启动表达式string
cronState定时任务是否启动，0不启动，1启动string
machineCode工作流所在机器的机器码string
qywxRoburl企业微信群发urlstring
autoWorkStatistics是否自动统计工时（0代表否，1代表是）Int
workTime单笔节省工时double
startParam任务启动参数（json str 格式）string
workflowIdworkflowIdstring

响应体示例

json
{
	"msg": "success",
	"code": 0,
	"data": {
		"totalCount": 1505,
		"pageSize": 10,
		"totalPage": 151,
		"currPage": 1,
		"list": [{
			"taskId": 9334,
			"taskName": "单步调试",
			"machineCode": "E143D6209B53FAED153B6E0AFD30083E",
			"cron": "",
            "cronState": 0,
			"qywxRoburl": null,
			"workTime": null,
			"autoWorkStatistics": 0,
			"workflowId": "xxxxxxxxxxx",
            "startParam": "{\"a\":123}"
		}]
	}
}

启动任务接口 ​

url：/api/taskInstance/start

HTTP Method : POST JSON

请求头:

参数名称参数说明是否必须数据类型
accessToken鉴权接口获取的accessTokentrueString

请求参数:

参数名称参数说明是否必须数据类型
workflowIdworkflowIdtruelong
machineCode机器码truestring
startParam任务启动参数Falsestring

响应参数:

参数名称参数说明类型
code0-成功，1-失败int
msg返回消息string
data返回数据，data.taskInstanceId为任务运行idObject

响应体示例

json
{
	"code": 0,
	"msg": "success",
	"data": {
    	"taskInstanceId": "fc38fbsa-8333-1111-83f8-3292aaaaaa"
  	}
}

启动任务并查询结果接口 ​

url：/api/taskInstance/startAndGetResult

HTTP Method : POST JSON

请求头:

参数名称参数说明是否必须数据类型
accessToken鉴权接口获取的accessTokentrueString

请求参数:

参数名称参数说明是否必须数据类型
workflowIdworkflowId，如果是执行任务则必传falselong
machineCode机器码，如果是执行任务则必传falsestring
startParam任务启动参数Falsestring
instanceId任务运行id，如果是查询任务执行结果则必传falsestring

响应参数:

参数名称参数说明类型
code0-成功，1-失败int
msg返回消息string
data返回数据，data.taskInstanceId为任务运行idObject

响应体示例

json
{
   "code": 0,
   "msg": "success",
   "data": {
       "taskInstanceId": "fc38fbsa-8333-1111-83f8-3292aaaaaa",
       "outParam":"{\"查询编号\":\"xx\",\"paid_sick_leave\":\"5\",\"paid_annual_leave\":\"2\",\"parental_leave\":\"0\",\"compensatory_leave\":\"0\"}",
       "executeMsg":"工作流执行完成"
   }
}

请求示例

curl --location --request POST 'http://localhost:8080/rpa-console/api/taskInstance/startAndGetResult' \
--header 'accessToken: 2242ac0a042642749f53e92d9469d828' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=17621d86-ec31-498e-b505-9274a696badf' \
--data-raw '{
    "workflowId":"8e089065-ecd2-43ec-9acd-0d42773795aa",
    "machineCode":"8EACE5E3C3756FC07A1C2ECF088D27A3",
    "startParam":"{\"查询编号\":\"xx\"}"
}'

通过groupId启动任务并查询结果接口 ​

url：/api/taskInstance/startAndGetResultByGroupId

HTTP Method : POST JSON

请求头:

参数名称参数说明是否必须数据类型
accessToken鉴权接口获取的accessTokentrueString

请求参数:

参数名称参数说明是否必须数据类型
groupIdgroupId即为绑定任务的任务调度ID，该参数必传Truelong
startParam任务启动参数Falsestring

响应参数:

参数名称参数说明类型
code0-成功，1-失败int
msg返回消息string
data返回数据，data.taskInstanceId为任务运行idObject

响应体示例

json
{
   "code": 0,
   "msg": "success",
   "data": {
        "taskInstanceId": "b75f57bd-10c0-458c-8a76-5a15f76e1f14",
        "taskName": null,
        "workflowId": "0a6bfe2c-1499-4252-934f-8bd8237b05ea",
        "machineCode": "8EACE5E3C3756FC07A1C2ECF088D27A3",
        "status": null,
        "startTime": null,
        "outParam": null,
        "executeMsg": "运行中"
   }
}

请求示例

curl --location --request POST 'http://localhost:8080/rpa-console/api/taskInstance/startAndGetResultByGroupId' \
--header 'accessToken: 2242ac0a042642749f53e92d9469d828' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=17621d86-ec31-498e-b505-9274a696badf' \
--data-raw '{
    "groupId":"88b82caa-1471-4967-9c50-b60e5296887b",
}'

停止任务运行接口 ​

url：/api/taskInstance/stop

HTTP Method : POST JSON

请求头:

参数名称参数说明是否必须数据类型
accessToken鉴权接口获取的accessTokentrueString

请求参数:

参数名称参数说明是否必须数据类型
taskInstanceId工作流运行IdtrueString

响应参数:

参数名称参数说明类型
code0-成功int
msg返回消息string

响应体示例

json
{
	"code": 0,
	"msg": "success"
}

任务运行回调接口 ​

url：开放接口管理页面设置的回调接口url

HTTP Method : POST JSON

请求头:

参数名称参数值数据类型
Content-Typeapplication/jsonString

请求参数:

参数名称参数说明是否必须数据类型
workflowIdworkflowIdtruelong
taskName工作流名称Truestring
taskInstanceId工作流运行IdTruestring
machineCode机器码Truestring
status下发状态（0-排队中，1是运行中，2是完成，3是待下发）Trueint
startTime运行开始时间Truestring
executeStatus执行状态（0,2--成功，3,4-- 失败，未执行完则为空）int

响应参数:

参数名称参数说明类型
code0-成功，1-失败int
msg返回消息string

响应体示例

json
{
	"msg": "success",
	"code": 0
}

查询任务运行结果接口 ​

url：/api/taskInstance/info

HTTP Method : POST JSON

请求头:

参数名称参数说明是否必须数据类型
accessToken鉴权接口获取的accessTokentrueString

请求参数:

参数名称参数说明是否必须数据类型
taskInstanceId工作流运行idtruestring

响应参数:

参数名称参数说明类型
code0-成功int
msg返回消息string
data返回数据Object

data数据说明

参数名称参数说明类型
workflowIdworkflowIdstring
taskName工作流名称string
taskInstanceId工作流运行idstring
status下发状态（0-排队中，1是运行中，2是完成，3是待下发）int
machineCode工作流所在机器的机器码string
startTime运行开始时间string
executeStatus执行状态（0,2--成功，3,4-- 失败，未执行完则为空）int

响应体示例

json
{
	"msg": "success",
	"code": 0,
	"data": {
		"workflowId": "9334",
		"taskName": "单步调试",
		"machineCode": "E143D6209B53FAED153B6E0AFD30083E",
		"status": 2,
		"taskInstanceId": "sdasdadadsasdad",
		"startTime": "2023-08-30 11:00:11"	
    }
}

查询任务日志列表接口 ​

url：/api/taskLog/list

HTTP Method : POST JSON

请求头:

参数名称参数说明是否必须数据类型
accessToken鉴权接口获取的accessTokentrueString

请求参数:

参数名称参数说明是否必须数据类型
taskName工作流名称Falsestring
machineCode机器码Falsestring
status运行状态（0,2--成功，3,4-- 失败）Falseint
instanceId任务执行idFalsestring
page分页之第几页，默认值1falseInt
pageSize分页之每页多少条，默认值10Falseint

响应参数:

参数名称参数说明类型
code0-成功int
msg返回消息string
data返回数据Object

​ data数据说明：

参数名称参数说明类型
curPage当前页页码int
pageSize分页之每页多少条int
list列表数据List
totalCount数据总量int
totalPage页数总量int

list数据说明

参数名称参数说明类型
workflowIdworkflowIdsrting
taskName工作流名称string
status运行状态（0,2--成功，3,4-- 失败）string
machineCode工作流所在机器的机器码string
startTime运行开始时间string
endTime运行结束时间string

响应体示例

json
{
	"msg": "success",
	"code": 0,
	"data": {
		"totalCount": 1505,
		"pageSize": 10,
		"totalPage": 151,
		"currPage": 1,
		"list": [{
			"workflowId": "9334",
			"taskName": "单步调试",
			"machineCode": "E143D6209B53FAED153B6E0AFD30083E",
			"status": "2",
			"startTime": null,
			"endTime": null
		}]
	}
}

机器人相关接口 ​

查询机器人列表接口 ​

url：/api/robot/list

HTTP Method : POST JSON

请求头:

参数名称参数说明是否必须数据类型
accessToken鉴权接口获取的accessTokentrueString

请求参数:

参数名称参数说明是否必须数据类型
machineCode机器码Falsestring
status机器状态（0：已禁用，1：离线，2：在线）Falseint
page分页之第几页，默认值1falseInt
pageSize分页之每页多少条，默认值10Falseint

响应参数:

参数名称参数说明类型
code0-成功int
msg返回消息string
data返回数据Object

data数据说明：

参数名称参数说明类型
curPage当前页页码int
pageSize分页之每页多少条int
list列表数据List
totalCount数据总量int
totalPage页数总量int

list数据说明

参数名称参数说明类型
machineCode机器码string
alias机器名string
status运行状态（0：已禁用，1：离线，2：在线）string
ipip地址string
robotVersion版本号string
installTime安装时间string

响应体示例

json
{
	"msg": "success",
	"code": 0,
	"data": {
		"totalCount": 250,
		"pageSize": 10,
		"totalPage": 25,
		"currPage": 1,
		"list": [{
			"machineCode": "01221E2CAE5E16B648C381C81CD0429B",
			"alias": "Administrator",
			"terminal": "YJY-WORKER-4",
			"ip": 168506101,
			"robotVersion": "4.0.5",
			"installTime": "2022-10-21 17:05:26",
			"status":  "1"
		}]
	}
}

状态码说明 ​

错误码说明排查建议
0正常调用正常
300签名signature错误排查signature计算是否正确
301appId/appSecret错误appId/appSecret错误，请用企业管理员登录后台并进行核对
302appId/appSecret不可用请用账号登录后台并进行核对 appId/appSecret是否可用
303接口参数错误请按照接口文档检查参数是否设置有误
304token为空请在请求头中设置accesstoken参数
305token已失效请重新获取accesstoken
500未知异常请联系技术支持进行排查

Last updated: