小安云-API http接口文档

心跳请求-5001

功能说明:用于插件守护手机按键脚本的心跳功能;当脚本被插件启动后,插件会根据脚本交互的心跳来判断脚本功能是否正常运作;

请求地址:http://127.0.0.1:8181/api?reqCode=5001

请求参数

参数 是否
必选
说明
reqCode 编码:5001,接口请求码

响应参数

参数 说明
RespCode 0:表示成功,1:表示成功但存在警告信息,-1:表示失败,2:表示任务执行中
Message 消息提示
Data 数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "调用成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "调用失败" 
    "Data": null
}

获得设备帐号详情-5002

功能说明:获取该设备对应的帐号数据 -- 在小安云后台设置

请求地址:http://127.0.0.1:8181/api?reqCode=5002&flag=0

请求参数

参数 是否
必选
说明
reqCode 编号:5002,接口请求码
flag 帐号标记(默认值为0)

响应参数

参数 说明
RespCode 0:表示成功,1:表示成功但存在警告信息,-1:表示失败,2:表示任务执行中
Message 消息提示
Data
数据 ,Data返回值详细介绍:
Account:账号 string
Password:密码 string
QuFu:区服 string
flag:标记 string 默认为0,标记账号,获取账号的时候带上标记,则获取到相应标记的账号
AccountConfig:账号配置,string,Json数据结构或者普通字符串
ColumnConfig:列配置,string,列配置, 自动增长列,额外列的信息,没用到可以忽略
ProjectName:项目名称,string
ProjectConfigFile:项目配置文件地址,string,连接地址

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "获取帐号成功" 
    "Data": {       
      "Account": "ddlove",
      "Password": "123456",
      "QuFu": "1629",
      "AccountConfig": "gg=盟矿=VIP=人物技能=学院=许愿粮=资源木=捐献=校场=冲车=开地=帐篷=升田=宝藏=资源铁",
      "ColumnConfig": "[{\"ColumnName\":\"file1\",\"ColumnDes\":\"文件1\",\"ColumnValue\":\"\",\"IsDefaultColumn\":true},{\"ColumnName\":\"file2\",\"ColumnDes\":\"文件2\",\"ColumnValue\":\"\",\"IsDefaultColumn\":true}]",
      "ProjectName": "非凡的日子",
      "ProjectConfigFile": ""
    }
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "获取帐号失败" 
    "Data": null
}

修改设备帐号状态-5003

功能说明:修改该设备对应帐号的状态 -- 可在小安云后台设置查看

请求地址:http://127.0.0.1:8181/api?reqCode=5003&account=xxx&status=2&flag=3

请求参数

参数 是否
必选
说明
reqCode 编号:5003,接口请求码
Account 帐号
status 帐号状态值(int/默认值1),待运行 ,2已运行;
flag 帐号标记 (int/默认值1))

响应参数

参数 说明
RespCode 0:表示成功,1:表示成功但存在警告信息,-1:表示失败,2:表示任务执行中
Message 消息提示
Data 数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "调用成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "调用失败" 
    "Data": null
} }
}

上传设备帐号所对应的文本-5004

功能说明:上传修改该设备对应帐号的文本数据信息 -- 可在小安云后台设置查看

请求地址:http://127.0.0.1:8181/api?reqCode=5004&account=xxx&columnName=text1&columnValue=xxxx

请求参数

参数 是否
必选
说明
reqCode 编号:5004,接口请求码
Account 帐号
columnName 上传数据类型,取值:text1,text2
columnValue 当columnName为text1,text2时候,直接上传对应的文本值

响应参数

参数 说明
RespCode 0:表示成功,1:表示成功但存在警告信息,-1:表示失败,2:表示任务执行中
Message 消息提示
Data 数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "调用成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "调用失败" 
    "Data": null
}

压缩文件-5005

功能说明:压缩文件 -- 可与抹机王备份/还原配套使用

请求地址:http://127.0.0.1:8181/api?reqCode=5005&filePath=/sdcard/test&zipPath=/sdcard/yztc/test.zip

请求参数

参数 是否
必选
说明
reqCode 编号:5005,接口请求码
filePath 要压缩的文件/string
zipPath 压缩后的文件zip路径/string

响应参数

参数 说明
RespCode 0:表示成功,1:表示成功但存在警告信息,-1:表示失败,2:表示任务执行中
Message 消息提示
Data 数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "调用成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "调用失败" 
    "Data": null
}

解压文件-5006

功能说明:解压文件 -- 可与抹机王备份/还原配套使用

请求地址:http://127.0.0.1:8181/api?reqCode=5006&zipPath=/sdcard/yztc/test.zip&unZipPath=/sdcard/yztc

请求参数

参数 是否
必选
说明
reqCode 编号:5006,接口请求码
zipPath 压缩后的文件zip路径/string
unZipPath 解压到具体的路径下/string

响应参数

参数 说明
RespCode 0:表示成功,1:表示成功但存在警告信息,-1:表示失败,2:表示任务执行中
Message 消息提示
Data 数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "调用成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "调用失败" 
    "Data": null
}

上传ftp文件-5007

功能说明:上传ftp文件 -- 局域网内使用

请求地址:http://127.0.0.1:8181/api?reqCode=5007&localPath=/sdcard/test.zip&ftpPath=/cache/test.zip

请求参数

参数 是否
必选
说明
reqCode 编号:5007,接口请求码
localPath 本地的文件路径/string
ftpPath 上传到ftp的文件路径/string

响应参数

参数 说明
RespCode 0:表示成功,1:表示成功但存在警告信息,-1:表示失败,2:表示任务执行中
Message 消息提示
Data 数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "调用成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "调用失败" 
    "Data": null
}

下载ftp文件-5008

功能说明:下载ftp文件 -- 局域网内使用

请求地址:http://127.0.0.1:8181/api?reqCode=5008&localPath=/sdcard/test.zip&ftpPath=/cache/test.zip

请求参数

参数 是否
必选
说明
reqCode 编号:5008,接口请求码
localPath 下载到本地的文件路径/string
ftpPath ftp上的文件路径/string

响应参数

参数 说明
RespCode 0:表示成功,1:表示成功但存在警告信息,-1:表示失败,2:表示任务执行中
Message 消息提示
Data 数据

返回值示例说明


任务成功
{
    "RespCode": "0", 
    "Message": "调用成功" 
    "Data": null
}

接口访问失败
{
    "RespCode": "-1", 
    "Message": "调用失败" 
    "Data": null
}