全部产品
云市场
云游戏

15.服务型机器人调用的新方法

更新时间:2020-04-20 10:05:53

应用场景

服务型机器人有啥妙用呢,在此科普下,阿里云RPA服务型机器人可以通过API接口远程调用服务型机器人执行相应的程序。具体场景比如:一个企业需要建立自己的数据中台,而建立数据中台需要从各个已有的系统增删改查数据,对有现成接口的系统来说的话,可以很轻松的接入数据中台,而那些没有现成接口的系统想接入数据中台的话,有两种方案:一是对系统进行改造,增加对外使用的接口。二是使用我们RPA的服务型机器人,从系统的表现层操作,把一个个具体的业务转化成接口。对于这两种方案来说,后一种开发成本更低、开发时间更短,且不需要对原有的系统进行改造,显然这种方案更优。
想必大多数小伙伴们都使用过我们的接口调用服务型机器人啦,我们上新的方法可以满足POST请求中Body参数中只填一个json参数的操作呢,全方位简化传参以及取值啦~

接口介绍

调用地址:http://{rpahost}/rpa/api/ak/server/run
调用方式:POST
返回类型:JSON
请求参数(Headers):

参数 类型 描述
accessKey String 从控制台中获取到的 accessKey
accessKeySecret String 从控制台中获取到的 accessKeySecret

请求参数(Body):

config参数说明:
config是一个一维的 json object 对象。

  1. {
  2. "appParams": "{\"params\":\"cserver\"}",
  3. "robotUuid": "499a9ed1-43e1-49fb-8feb-577da4xxxxxx",
  4. "appUuid":"ad82165d-32e0-4fe5-bc11-exxxxxxxxxxx",
  5. "callbackUrl": "",
  6. "timeout": 0
  7. }

key

类型

必选

可选值

默认值

说明

appParams

string

-

-

应用的参数json对象的序列化string,注意转义。

robotUuid

string

-

-

服务型机器人的唯一识别符,如果不指定,则会随机选择一个空闲的服务型机器人。

appUuid

string

-

-

通过获取市场中所有服务型应用列表的接口查询的appUuid,必填。

callbackUrl

string

-

-

回调的url地址,如果有指定这个值,那么需要保证这个接口地址是可以直接调用到的。目前没有鉴权的能力。服务端会以POST的方式进行调用,返回的结果,会放在request的body中。

timeout

int

-

3600

任务最大等待时间(单位秒)。默认值为一小时。

接口回调数据说明:
回调的数据,是在机器人执行的应用中,调用api:rpa.workbench.``task_result(string) 写入的,写入的string需要是一个标准的json object对象。
callbackUrl 需要满足如下条件:

  1. http 或 https 的 post 请求。
  2. 接口免登
  3. Content-type:application/x-www-form-urlencoded
  4. 数据采用 form 表单方式发送,键值为:data

操作前提

亲爱的小伙伴们,请注意使用这个新接口是有条件的喔!

1.调用地址:http://{rpahost}/rpa/api/ak/server/run 中的{rpahost}需要替换成自己的控制台域名
2.请求参数(Headers)是必填参数,需要自己去 控制台-系统设置 中去获取相关的参数哦
3.请求参数(Body)中JSON参数中的appUuid必填参数,需要自己提前获取哦,可以通过获取市场中所有服务型应用列表的接口查询appUuid 《获取市场中所有服务型应用列表的方法》
4.请求参数(Body)中JSON参数中的robotUuid非必填参数,如果不指定,则会随机选择一个空闲的服务型机器人。如果填写需要自己提前获取哦,可以通过查询服务型机器人列表的接口去查询robotUuid 《查询服务型机器人列表》

使用方法

请求示例(以Postman为例):
第一步:获取市场中所有服务型应用列表
获取市场中所有服务型应用列表.jpg

返回的结果如下,返回结果中的uuid即为我们需要appUuid,使用时选择需要调用应用对应的uuid:

1.jpg

第二步:调用服务型机器人
1.填写Headers参数

服务型机器人调用.jpg

2.填写Body参数
1.jpg
3.取到返回结果
2.jpg


请求正常返回如下数据**:

  1. {
  2. "success": true,
  3. "code": 0,
  4. "msg": "SUCCESS",
  5. "data": {
  6. "taskId": "48c1e663-ae81-42cc-94c6-aaf7af13exxxx",
  7. "resultUrl": "/rpa/api/ak/server/result?uuid=48c1e663-ae81-42cc-94c6-aaf7af13xxxx"
  8. },
  9. "pager": null
  10. }
字段 描述
success 这个接口内部运行是否成功
code 这个接口内部运行状态码,成功为0
msg 这个接口内部运行后的信息描述,成功为“SUCCDESS”
data taskId 任务id,用于查询任务运行状态使用
resultUrl 任务运行结果的查询接口
page 分页信息(请忽略这个字段)

失败返回示例

错误码定义:

错误码 错误信息 描述
404 请求资源不存在 请求资源不存在,请核对请求的路径
401 您无该功能的权限,请核对AK信息 您无该功能的权限,请核对AK信息
405 请求方法错误 请求方法错误,请核对你请求的方法
500 服务器错误,请稍后重试 服务器错误,请稍后重试