AutoSense开放接口协议

作者：admin  浏览 1793 发布时间： 更新时间：

AutoSense开放接口协议

文档更新记录

时间 更新人 更新内容
2018-01-15 范海洋 创建文档
2018-02-02 范海洋 增加任务状态进度查询接口，创建任务返回taskId

规范

数据类型

application/json

请求方式

POST包体

内容编码

UTF-8

接口域

http://IP:PORT

请求包体的参数

参数 类型 长度 必须？ 示例值 描述
data Object - 是 - 请求包体的数据根节点
apikey String - 是 接口密钥，可登录后台在我的信息里获取。

接口

创建业务拨测测试接口

接口地址

http://IP:PORT/uapi/task/create

请求参数

参数名 类型 长度 必须？ 示例值 描述
taskName String 30 是 XXXXX 任务名称
tasks Object - 是 任务中的设备与脚本信息
deviceId Int 11 是 1234 设备ID
scriptId Array - 是 [“123”, “345”,] 脚本Id
taskType Int 1 是 1 任务类型 1 = autosense
exeType Int 1 是 2 执行类型，1=按时，2=按次，默认2
taskParameter String - 否 任务自定义的参数，默认空
netCapture Int 1 是 0 是否抓包，1=是，0=否，默认0
startTime String 20 是 2017-07-01 12:12:12 开始时间，格式：2017-07-01 12:12:12，默认是当前时间
iterationNum Int 11 是 2 执行次数，默认1
interval Int 11 是 12 间隔时间，单位：分钟，默认1
startDateTime String 20 是 2017-07-01 12:12:12 开始时间，格式：2017-07-01 12:12:12，默认是当前时间
endDateTime String 20 是 2017-07-01 23:59:59 结束时间，格式：2017-07-01 23:59:59，默认是当天零点
exeBeginTime String 10 是 12:12:12 每天执行开始时间，格式：12:12:12，默认为00:00:01
exeEndTime String 10 是 13:59:59 每天执行结束时间，格式：23:59:59，默认23:59:59
iterationType Int 1 是 1 重复类型，0=不限，1=每天，2=每周，3=每月，默认1

请求示例：exeType(执行类型) 不同，参数也有些不一样

  1. // 按次执行任务所需要的参数
  2. {
  3. "apiKey":APIKey,
  4. "data":{
  5.         "taskName": "XXXXXXX",
  6.          // 设备与脚本信息
  7.          "tasks": [{
  8.                     "deviceId": "1234",
  9.                      "scriptIds": ["123", "345", "567"]
  10.                     },
  11.                     {
  12.                      "deviceId": "123",
  13.                      "scriptIds": ["123", "345", "567"]
  14.                     }
  15.                   ],
  16.         "netCapture": "0",
  17.         "taskParameter": "",
  18.         "taskType": "1",
  19.         "exeType": "2",
  20.         "startTime": "2017-07-01 12:12:12",
  21.         "iterationNum": "1",
  22.         "interval": "2"
  24. }
  27. //按时执行所需要的参数
  28. {
  29. "apiKey":APIKey,
  30. "data":{
  31.         "taskName": "XXXXXXX",
  32.          // 设备与脚本信息
  33.          "tasks": [{
  34.                     "deviceId": "1234",
  35.                      "scriptIds": ["123", "345", "567"]
  36.                     },
  37.                     {
  38.                      "deviceId": "123",
  39.                      "scriptIds": ["123", "345", "567"]
  40.                     }
  41.                   ],
  42.         "netCapture": "0",
  43.         "taskParameter": "",
  44.         "taskType": "1",
  45.         "exeType": "1",
  46.         "startDateTime": "2017-07-01 12:12:12",
  47.         "endDateTime": "2017-07-01 23:59:59",
  48.         "exeBeginTime": "00:00:01",
  49.         "exeEndTime": "23:59:59",
  50.         "iterationType": "1",
  51.         "iterationNum": "1",
  52.         "interval": "1"
  53. }

返回字段

字段名称 类型 示例值 描述
status Int 1 状态，1表示成功，其他表示失败
message String 返回消息
data Object 数据对象
timestamp String 时间戳

返回示例

  1. {
  2.   "status":1,
  3.   "message":"task create success.",
  4.   "data":{ "taskId": "1" },
  5.   "timestamp":"1510038361"}

创建遍历测试接口

接口地址

http://IP:PORT/uapi/task/create

请求参数

参数名 类型 长度 必须？ 示例值 描述
deviceId Array 是 [“123”, “345”, “567”] 设备ID
scriptId Int 1 是 1 遍历测试公共脚本, 固定值 1
appId Int 11 是 12345 应用ID
taskType Int 1 是 2 任务类型 2 = 遍历测试
isCoverInstall String 15 否 0 是否覆盖安装 1:是; 0:否, 默认0

请求示例

  1. {
  2. "apiKey":APIKey,
  3. "data":{
  4.         "tasks": {
  5.                 "deviceId":["1301047","1301048","1301039"],
  6.                 "scriptId":"1",
  7.                 "appId":"417",
  8.                 }
  9.          "isCoverInstall":0,
  10.          "taskType":"2",
  11.         }
  12. }

返回字段

字段名称 类型 示例值 描述
status Int 1 状态，1表示成功，其他表示失败
message String 返回消息
data Object 数据对象
timestamp String 时间戳

返回示例

  1. {
  2.   "status":1,
  3.   "message":"task create success.",
  4.   "data":{ "taskId": "1" },
  5.   "timestamp":"1510038361"}

上传应用接口

接口地址

http://IP:PORT/uapi/uploadapp/upload

请求参数

参数 类型 长度 必须？ 示例值 描述
apikey String - 是 8042A624743E8F92553E7B854A98F04C 接口密钥，可登录后台在我的信息里获取。
fileupload String 是 @/Users/xxxxx/Downloads/tt/dianshijia.apk 上传文件路径

请求示例：

  1. curl -F "apiKey=APIKey" -F "fileupload=@/Users/xxxxx/Downloads/tt/dianshijia.apk"  http://IP:PORT/uapi/uploadapp/upload

返回字段

字段名称 类型 示例值 描述
status Int 1 状态，1表示成功，其他表示失败
message String 返回消息
data Object 数据对象
appId Int 应用ID
timestamp String 时间戳

返回示例

  1. { 
  2.   "status":1,
  3.   "message":"upload app success.",
  4.   "data":{ "appId": "481" },
  5.   "timestamp":1515745035
  6. }

获取设备状态接口

接口地址

http://IP:PORT/uapi/device/status

请求参数

字段名称 类型 长度 必须？ 示例值 描述
imei String 50 是 A000004F5252B4dd 设备IMEI号

请求示例：

  1. {
  2. "apiKey":APIKey,
  3. "data":{
  4.         "imei": "A000004F5252B4dd"
  5.         }
  6. }

返回字段

字段名称 类型 示例值 描述
status Int 1 状态，1表示成功，其他表示失败
message String 返回消息
data Object 数据对象
deviceStatus Int 设备状态 00：空闲;01：占用;02：异常;03：离线
timestamp String 时间戳

返回示例

  1. { 
  2.   "status":1,
  3.   "message":"upload app success.",
  4.   "data":{ "deviceStatus": "01" },
  5.   "timestamp":"1515745035"
  6. }

获取任务状态接口

接口地址

http://IP:PORT/uapi/task/getTaskStatus

请求参数

字段名称 类型 长度 必须？ 示例值 描述
taskType Int 11 是 1 任务类型 1 = autosense, 2 =遍历或者兼容性测试
taskId Int 1 是 1 任务ID

请求示例：

  1. {
  2. "apiKey":APIKey,
  3. "data":{
  4.         "taskType": "1",
  5.         "taskId": "1"
  6.         }
  7. }

返回字段

字段名称 类型 示例值 描述
status Int 1 状态，1表示成功，其他表示失败
message String 返回消息
data Object 数据对象
status Int 1 taskType = 1 时， 0: 执行中, 1: 已完成, ２: 已过期 ， taskType = 2 时 ， 0: 等待测试, 1: 测试中, 2: 已终止, 3: 已完成
completedNum Int 2 已完成的数量
totalNum Int 5 总数量
timestamp String 时间戳

返回示例

  1. { 
  2.   "status":1,
  3.   "message":"",
  4.   "data":{ "status": "1","completedNum":"0","totalNum":"2" },
  5.   "timestamp":"1515745035"
  6. }

​