开发者可以使用open api调用冰狐智能辅助后端服务进行二次开发,api统一返回json数据格式。获取token、刷新token、获取设备列表、获取设备信息、获取设备状态、启动设备、停止设备、设置设备自定义数据、获取用户信息、创建用户、用户登录、获取用户列表、调用微服务
成功时,state为1,data为返回数据;失败时state为-1,data为错误描述 { state:1 data:{...} }
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
clientSecret | string | 必填 | 开发者Secret |
参数名 | 类型 | 说明 |
---|---|---|
accessToken | string | 访问token |
refreshToken | string | 刷新token |
expiredIn | integer | 过期时间,秒为单位 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
refreshToken | string | 必填 | 刷新token |
参数名 | 类型 | 说明 |
---|---|---|
accessToken | string | 访问token |
refreshToken | string | 刷新token |
expiredIn | integer | 过期时间,秒为单位 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
openId | string | 选填 | 用户id,默认返回管理者的设备 |
cursor | integer | 选填 | 分页游标,默认0 |
count | integer | 选填 | 页大小,默认-1,返回所有数据 |
参数名 | 类型 | 说明 |
---|---|---|
list | array | 设备数据 |
total | integer | 设备总数量 |
名称 | 类型 | 说明 |
---|---|---|
uuid | string | 设备uuid |
name | string | 设备名 |
phoneNumber | string | 设备手机号 |
extraData | json object string | 用于存放开发者自定义数据 |
enable | boolean | 设备是否可用,false表示设备目前不可用 |
days | integer | 可用天数 |
onlineState | integer | 工作状态,0表示离线,1表示在线,2表示在线但服务不可用 |
workState | integer | 工作状态,0表示空闲,1表示繁忙 |
devState | integer | 开发模式,0表示开发模式,1表示发布模式 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
uuid | string | 必填 | 设备uuid |
参数名 | 类型 | 说明 |
---|---|---|
uuid | string | 设备uuid |
name | string | 设备名 |
phoneNumber | string | 设备手机号 |
extraData | json object string | 用于存放开发者自定义数据 |
enable | boolean | 设备是否可用,false表示设备目前不可用 |
days | integer | 可用天数 |
onlineState | integer | 工作状态,0表示离线,1表示在线,2表示在线但服务不可用 |
workState | integer | 工作状态,0表示空闲,1表示繁忙 |
devState | integer | 开发模式,0表示开发模式,1表示发布模式 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
uuid | string | 必填 | 设备uuid |
参数名 | 类型 | 说明 |
---|---|---|
onlineState | integer | 工作状态,0表示离线,1表示在线,2表示在线但服务不可用 |
workState | integer | 工作状态,0表示空闲,1表示繁忙 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
uuid | string | 必填 | 设备uuid |
参数名 | 类型 | 说明 |
---|
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
uuid | string | 必填 | 设备uuid |
refreshApp | boolean | 选填 | 停止脚本后是否把冰狐切换到前台,默认:true |
参数名 | 类型 | 说明 |
---|
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
uuid | string | 必填 | 设备uuid |
data | string | 必填 | 数据 |
参数名 | 类型 | 说明 |
---|
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
openId | string | 选填 | 用户id,默认获取当前管理员的信息 |
参数名 | 类型 | 说明 |
---|---|---|
openId | string | 用户id |
username | string | 用户名 |
phoneNumber | string | 电话号码 |
string | 电子邮箱 | |
wx | string | 微信号 |
createTime | integer | 创建时间 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
username | string | 必填 | 用户名 |
password | string | 选填 | 密码 |
phoneNumber | string | 选填 | 电话号码 |
wx | string | 选填 | 微信号 |
参数名 | 类型 | 说明 |
---|---|---|
openId | string | 用户id |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
username | string | 必填 | 用户名 |
password | string | 必填 | 密码 |
参数名 | 类型 | 说明 |
---|---|---|
openId | string | 用户id |
username | string | 用户名 |
phoneNumber | string | 电话号码 |
string | 电子邮箱 | |
wx | string | 微信号 |
createTime | integer | 创建时间 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
cursor | integer | 选填 | 分页游标,默认为0 |
count | integer | 选填 | 页大小,默认为-1 |
参数名 | 类型 | 说明 |
---|---|---|
list | array | 用户数据 |
total | integer | 用户总数量 |
名称 | 类型 | 说明 |
---|---|---|
openId | string | 用户id |
username | string | 用户名 |
phoneNumber | string | 电话号码 |
string | 电子邮箱 | |
wx | string | 微信号 |
createTime | integer | 创建时间 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
name | string | 必填 | 接口名 |
isDev | boolean | 选填 | 是否为开发模式,默认值false |
params | json array | 选填 | 接口参数,接口参数和接口对应的后端脚本参数一致,json数组中每个元素对应一个实际参数,如果餐宿是json数据,则key和字符串必须用双引号,例如:[{"a":"good", "b":false}, 1],第一个实参为{"a":"good", "b":false},第二个实参为1。注意这里在调用之前需要encodeUri |
参数名 | 类型 | 说明 |
---|---|---|
return | object | 接口返回值和接口对应脚本的返回值一致 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
clientKey | string | 必填 | 开发者key |
accessToken | string | 必填 | 访问token |
name | string | 必填 | 脚本名 |
isDev | boolean | 选填 | 是否为开发模式,默认值false |
params | json array | 选填 | 脚本参数必须与后端脚本参数一致,json数组中每个元素对应一个实际参数,如果是参数是json数据,则key和字符串必须用双引号,例如:[{"a":"good", "b":false}, 1],第一个实参为{"a":"good", "b":false},第二个实参为1。注意这里在调用之前需要encodeUri |
参数名 | 类型 | 说明 |
---|---|---|
return | object | 返回值和对应后端脚本的返回值一致 |