[关闭]
@cfygaoyang 2020-03-09T07:17:55.000000Z 字数 21744 阅读 1424

352 App接口文档

错误码

错误码 信息 描述
10000 通用错误码
10001 invalid account format 账号格式错误
10002 invalid account 账号错误
10003 invalid password 密码错误
10004 invalid token token错误
10005 invalid code 验证码错误
10006 sms server error 短信服务超过次数
10007 email server error 邮件服务错误
10008 invalid refresh token 刷新token失败
10009 code expired 验证码过期
10010 account has existed 账号已注册
10011 字段不合法校验
10012 sms error 短信服务发送错误

账号体系

获取验证码

POST /api/auth/send_code

参数 类型 必须 说明
account 字符串 是 手机或邮箱
area 字符串 可选 手机区号；默认为86，另外当account不为手机号时，此参数无效 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

校验验证码

POST /api/auth/check_code

参数 类型 必须 说明
account 字符串 是 手机或邮箱
code 字符串 是 验证码
area 字符串 可选 手机区号；默认为86，另外当account不为手机号时，此参数无效 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

验证码登录

POST /api/auth/code_login

参数 类型 必须 说明
account 字符串 是 手机或邮箱
code 字符串 是 验证码
area 字符串 可选 手机区号；默认为86，另外当account不为手机号时，此参数无效 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23 10:47:16",
  8.         "expires_in": 68400
  9.     }
  10. }
参数 类型 说明
access_token 字符串 接口请求访问 token
refresh_token 字符串 用户刷新 token
expires_at 字符串 access_token有效期截止时间
expires_in 整型 access_token有效时长（单位：秒）

校验手机号

POST /api/auth/check_account

参数 类型 必须 说明
account 字符串 是 手机或邮箱
area 字符串 可选 手机区号；默认为86，另外当account不为手机号时，此参数无效 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "status": 0
  6.     }
  7. }
参数 类型 说明
status 整型 1:已注册, 0:未注册

注册

POST /api/auth/register

参数 类型 必须 说明
account 字符串 是 手机或邮箱
password 字符串 是 密码
code 字符串 是 验证码
area 字符串 可选 手机区号；默认为86，另外当account不为手机号时，此参数无效 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23 10:47:16",
  8.         "expires_in": 68400
  9.     }
  10. }
参数 类型 说明
access_token 字符串 接口请求访问 token
refresh_token 字符串 用户刷新 token
expires_at 字符串 access_token有效期截止时间
expires_in 整型 access_token有效时长（单位：秒）

获取 token

POST /api/auth/access_token

参数 类型 必须 说明
account 字符串 是 手机或邮箱
password 字符串 是 密码
area 字符串 可选 手机区号；默认为86，另外当account不为手机号时，此参数无效 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23 10:47:16",
  8.         "expires_in": 68400
  9.     }
  10. }
参数 类型 说明
access_token 字符串 接口请求访问 token
refresh_token 字符串 用户刷新 token
expires_at 字符串 access_token有效期截止时间
expires_in 整型 access_token有效时长（单位：秒）

刷新 token

POST /api/auth/refresh_token

参数 类型 必须 说明
refresh_token 字符串 是 刷新token 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23 10:47:16",
  8.         "expires_in": 68400
  9.     }
  10. }
参数 类型 说明
access_token 字符串 接口请求访问 token
refresh_token 字符串 用户刷新 token
expires_at 字符串 access_token有效期截止时间
expires_in 整型 access_token有效时长（单位：秒）

销毁 token

POST /api/auth/destroy_token

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

重置用户名

POST /api/auth/reset_username

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
username 字符串 是 用户名 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

校验密码

POST /api/auth/check_password

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
password 字符串 是 密码（6～16位） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

重置密码（token）

POST /api/auth/reset_password

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
password 字符串 是 密码（6～16位） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

重置密码（account,code,password）

POST /api/auth/reset_password_by_code

参数 类型 必须 说明
account 字符串 是 手机或邮箱
code 字符串 是 验证码
password 字符串 是 密码（6～16位）
area 字符串 可选 手机区号；默认为86，另外当account不为手机号时，此参数无效 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

重置密码（old_password,password）

POST /api/auth/reset_password_by_old_password

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
old_password 字符串 是 旧密码（6～16位）
password 字符串 是 新密码（6～16位） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

个人信息

获取个人信息

GET /api/personal/info

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "username": "admin",
  7.         "phone": "18656660930",
  8.         "email": "",
  9.         "register_time": "2018-12-20 17:00:52",
  10.         "age": 0,
  11.         "job": "",
  12.         "name": "",
  13.         "city": "",
  14.         "company": "",
  15.         "avatar": "",
  16.         "birthday": "",
  17.         "address": "",
  18.         "nick_name": "",
  19.         "sex": 2,
  20.         "login_time": "2019-01-04 11:49:31",
  21.         "login_ip": "202.96.204.195"
  22.     }
  23. }
参数 类型 说明
id 整型 数据唯一标识
username 字符串 用户名；唯一，可拓展用于登录
register_time 字符串 注册时间
login_time 字符串 最后登录时间
login_ip 字符串 最后登录 ip
nick_name 字符串 昵称
sex 整型 性别：0女1男2保密
address 字符串 地址
birthday 字符串 生日
avatar 字符串 头像链接
company 字符串 公司
city 字符串 城市
name 字符串 姓名
job 字符串 职位
age 字符串 年龄
email 字符串 邮箱
phone 字符串 手机

编辑个人信息

PUT /api/personal/info

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
avatar 字符串 可选 头像
birthday 字符串 可选 生日
sex 整型 可选 性别：0女1男2保密
city 字符串 可选 城市
address 字符串 可选 地址
company 字符串 可选 公司
job 字符串 可选 职称
name 字符串 可选 姓名
age 字符串 可选 年龄 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "username": "admin",
  7.         "phone": "18656660930",
  8.         "email": "",
  9.         "register_time": "2018-12-20 17:00:52",
  10.         "age": 0,
  11.         "job": "",
  12.         "name": "",
  13.         "city": "",
  14.         "company": "",
  15.         "avatar": "",
  16.         "birthday": "",
  17.         "address": "",
  18.         "nick_name": "",
  19.         "sex": 2,
  20.         "login_time": "2019-01-04 11:49:31",
  21.         "login_ip": "202.96.204.195"
  22.     }
  23. }
参数 类型 说明
id 整型 数据唯一标识
username 字符串 用户名；唯一，可拓展用于登录
register_time 字符串 注册时间
login_time 字符串 最后登录时间
login_ip 字符串 最后登录 ip
nick_name 字符串 昵称
sex 整型 性别：0女1男2保密
address 字符串 地址
birthday 字符串 生日
avatar 字符串 头像链接
company 字符串 公司
city 字符串 城市
name 字符串 姓名
job 字符串 职位
age 字符串 年龄
email 字符串 邮箱
phone 字符串 手机

推送绑定

同步推送绑定

POST /api/push/bind

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
client_id 字符串 是 推送标识
client_type 字符串 是 客户端类型：android 或 ios 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "client_id": "xxxxxxxxx",
  6.         "client_type": "ios",
  7.         "user_id": 1,
  8.         "created_at": "2018-08-22 16:06:00",
  9.         "updated_at": "2018-08-22 16:06:00",
  10.     }
  11. }

设置推送开关

POST /api/push/switch

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
switch 布尔型 是 推送开关, 可为空值,就是false 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "switch": true,
  6.         "user_id": 1,
  7.         "created_at": "2018-08-22 16:06:00",
  8.         "updated_at": "2018-08-22 16:06:00",
  9.     }
  10. }

获取推送开关

GET /api/push/switch

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "switch": true,
  6.         "user_id": 1,
  7.         "created_at": "2018-08-22 16:06:00",
  8.         "updated_at": "2018-08-22 16:06:00",
  9.     }
  10. }

设备绑定

同步绑定设备

POST /api/device/bind

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备标识
is_superuser 布尔型 是 是否是管理员
identify_id 字符串 可选 飞燕用户唯一标识
longitude 浮点型 可选 经度
latitude 浮点型 可选 纬度 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "iot_id": "xxxxxxxxx",
  6.         "user_id": 1,
  7.         "is_superuser": true
  8.     }
  9. }

同步解绑设备

DELETE /api/device/bind

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备标识
is_superuser 布尔型 是 是否是管理员 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

获取设备绑定的用户列表

GET /api/device/bind

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备标识

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "users": [
  6.             {
  7.                 "phone": "13162119608",
  8.                 "nick_name": "1316211960",
  9.                 "avatar": "",
  10.                 "user_id": 32,
  11.                 "date_time": "2019-04-08 16:31:29",
  12.                 "identify_id": ""
  13.             }
  14.         ]
  15.     }
  16. }

删除设备分享用户

POST /api/device/share_user_remove

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备标识
user_id 字符串 是 用户id

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

设备信息

获取设备详情

GET /api/device/info/{iot_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "_id": 2005,
  6.         "gmtModified": 1548330753000,
  7.         "activeTime": 1547022466000,
  8.         "deviceKey": "MjhNcivkJL5Bz7i6Ocgi",
  9.         "statusLast": 1,
  10.         "productKey": "a1JJL4qVSdo",
  11.         "gmtCreate": 1545905659000,
  12.         "iotId": "MjhNcivkJL5Bz7i6Ocgi0010bb2f00",
  13.         "deviceSecret": "uesA8OVEP3805YwW7rnR9ceVcEKMCVDZ",
  14.         "name": "device1",
  15.         "thingType": "DEVICE",
  16.         "region": "cn-shanghai",
  17.         "firmwareVersion": "app-1.0.0",
  18.         "rbacTenantId": "0FCD57C6F767495CAB15DA2A8B48436B",
  19.         "status": 3,
  20.         "status_update_time": "2019-01-24 19:52:33",
  21.         "online_time": 0,
  22.         "mac": "b0:f8:93:20:c4:93",
  23.         "pipelined_code": "",
  24.         "property": {
  25.             "FilterLifeTimeDays_1": {
  26.                 "value": 100,
  27.                 "time": 1547719392499
  28.             },
  29.             "FilterPosition": {
  30.                 "value": "PP",
  31.                 "time": 1547795983231
  32.             },
  33.             "FilterLifeTimePercent_1": {
  34.                 "value": 100,
  35.                 "time": 1547719392499
  36.             },
  37.             "FilterSN": {
  38.                 "value": "123324344234555",
  39.                 "time": 1547719392499
  40.             },
  41.             "WaterDepletionStatus": {
  42.                 "value": 1,
  43.                 "time": 1547719367382
  44.             },
  45.             "HeatingStatus": {
  46.                 "value": 1,
  47.                 "time": 1547719367382
  48.             },
  49.             "FinishedWaterTDS": {
  50.                 "value": 232,
  51.                 "time": 1547719366383
  52.             },
  53.             "RawWaterTDS": {
  54.                 "value": 244,
  55.                 "time": 1547719389505
  56.             },
  57.             "WaterTemperature": {
  58.                 "value": 32,
  59.                 "time": 1547719364369
  60.             },
  61.             "WasteWaterAdjustStatus": {
  62.                 "value": 1,
  63.                 "time": 1547719349345
  64.             },
  65.             "FilterLifeTimeDays_2": {
  66.                 "value": 50,
  67.                 "time": 1547719370397
  68.             },
  69.             "FilterLifeTimePercent_2": {
  70.                 "value": 50,
  71.                 "time": 1547719370397
  72.             }
  73.         },
  74.         "date_time": "2019-01-17 17:46:47",
  75.         "sn": "",
  76.         "is_bind": true,
  77.         "superuser_name": "15502112361",
  78.         "superuser_id": 9
  79.     }
  80. }

获取设备对应的超级用户信息

GET /api/device/superuser/{iot_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "superuser_id": 13,
  6.         "superuser_name": "发货吗好"
  7.     }
  8. }
  1. {
  2.     "code": 10015,
  3.     "message": "没有找到设备的超级用户",
  4.     "data": {}
  5. }

开屏页/活动页

获取开屏页/活动页

GET /api/screen/page

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 8,
  6.         "app_id": "",
  7.         "created_at": "2018-12-20 14:26:26",
  8.         "updated_at": "2018-12-20 14:26:26",
  9.         "picture": "xxxxxx",
  10.         "start_time": "2018-12-12 12:00:00",
  11.         "end_time": "2019-12-23 10:00:00",
  12.         "countdown": 3,
  13.         "category": 1,
  14.         "external_link": ""
  15.     }
  16. }
参数 类型 说明
picture 字符串 图片地址
start_time 字符串 有效起始时间
end_time 字符串 有效结束时间
countdown 字符串 倒计时（单位：秒）
external_link 字符串 外部链接

App版本号

获取App版本号

GET /api/app/version

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "ios": {
  6.             "id": 2,
  7.             "app_id": "",
  8.             "created_at": "2018-10-09 00:00:00",
  9.             "updated_at": "2018-10-09 00:00:00",
  10.             "version_name": "苹果1.0.0",
  11.             "version_number": "1.0.0",
  12.             "version_description": "",
  13.             "app_type": "ios"
  14.         },
  15.         "android": {
  16.             "id": 1,
  17.             "app_id": "",
  18.             "created_at": "2018-10-09 00:00:00",
  19.             "updated_at": "2018-10-09 00:00:00",
  20.             "version_name": "安卓1.0.0",
  21.             "version_number": "1.0.0",
  22.             "version_description": "",
  23.             "app_type": "android"
  24.         }
  25.     }
  26. }
参数 类型 说明
created_at 字符串 数据存储时间
updated_at 字符串 数据更新时间
id 整型 数据唯一标识
version_name 字符串 版本名称
version_number 字符串 版本号
app_type 字符串 app 类型

系统配置

获取系统链接

GET /api/system/links

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "links": [
  6.             {
  7.                 "name": "link_1",
  8.                 "link": "https://www.baidu.com",
  9.                 "label": "加湿器滤网购买链接"
  10.             },
  11.             {
  12.                 "name": "link_2",
  13.                 "link": "https://www.baidu.com",
  14.                 "label": "S100净水器滤芯购买链接"
  15.             },
  16.             {
  17.                 "name": "link_3",
  18.                 "link": "https://www.bhttps://detail.tmall.com/item.htm?spm=a212k0.12153887.0.0.61c0687dRqWOGw&id=595084638484&skuId=4138526613575aidu.com",
  19.                 "label": "S100净水器1号滤芯购买链接"
  20.             },
  21.             {
  22.                 "name": "link_4",
  23.                 "link": "https://detail.tmall.com/item.htm?spm=a212k0.12153887.0.0.61c0687dRqWOGw&id=595084638484&skuId=4138526613575",
  24.                 "label": "S100净水器2号滤芯购买链接"
  25.             },
  26.             {
  27.                 "name": "link_5",
  28.                 "link": "http://115.28.161.90:8003/document/29",
  29.                 "label": "352用户协议"
  30.             },
  31.             {
  32.                 "name": "link_6",
  33.                 "link": "http://115.28.161.90:8003/document/H60",
  34.                 "label": "Skin自然蒸发加湿器使用说明"
  35.             },
  36.             {
  37.                 "name": "link_7",
  38.                 "link": "http://115.28.161.90:8003/document/S100",
  39.                 "label": "S100净水机使用说明"
  40.             },
  41.             {
  42.                 "name": "link_8",
  43.                 "link": "https://www.jd.com",
  44.                 "label": "配置失败"
  45.             },
  46.             {
  47.                 "name": "link_9",
  48.                 "link": "http://115.28.161.90:8003/document/Y100",
  49.                 "label": "Y100空气净化器说明书"
  50.             },
  51.             {
  52.                 "name": "link_10",
  53.                 "link": "https://www.jd.com",
  54.                 "label": "Y100空气净化器购买链接"
  55.             },
  56.             {
  57.                 "name": "link_11",
  58.                 "link": "https://www.jd.com",
  59.                 "label": "Y100C空气净化器购买链接"
  60.             },
  61.             {
  62.                 "name": "link_12",
  63.                 "link": "http://115.28.161.90:8003/document/Y100C",
  64.                 "label": "Y100C空气净化器说明书"
  65.             },
  66.             {
  67.                 "name": "link_13",
  68.                 "link": "http://115.28.161.90:8003/document/K10",
  69.                 "label": "K10净水器使用说明书"
  70.             },
  71.             {
  72.                 "name": "link_14",
  73.                 "link": "https://www.jd.com",
  74.                 "label": "K10净水器滤芯购买链接"
  75.             },
  76.             {
  77.                 "name": "link_15",
  78.                 "link": "https://www.jd.com",
  79.                 "label": "K10净水器1号滤芯购买链接"
  80.             },
  81.             {
  82.                 "name": "link_16",
  83.                 "link": "https://www.jd.com",
  84.                 "label": "K10净水器2号滤芯购买链接"
  85.             },
  87.             {
  88.                 "name": "link_17",
  89.                 "link": "https://www.mxchip.com",
  90.                 "label": "X86空气净化器说明书"
  91.             },
  92.             {
  93.                 "name": "link_18",
  94.                 "link": "https://www.mxchip.com",
  95.                 "label": "X86空气净化器上（1号）滤芯购买链接"
  96.             },
  97.             {
  98.                 "name": "link_19",
  99.                 "link": "https://www.mxchip.com",
  100.                 "label": "X86空气净化器中（2号）滤芯购买链接"
  101.             },
  102.             {
  103.                 "name": "link_20",
  104.                 "link": "https://www.mxchip.com",
  105.                 "label": "X86空气净化器下（3号）滤芯购买链接"
  106.             },
  107.             {
  108.                 "name": "link_21",
  109.                 "link": "https://www.mxchip.com",
  110.                 "label": "X86C空气净化器说明书"
  111.             },
  112.             {
  113.                 "name": "link_22",
  114.                 "link": "https://www.mxchip.com",
  115.                 "label": "X86C空气净化器上（1号）滤芯购买链接"
  116.             },
  117.             {
  118.                 "name": "link_23",
  119.                 "link": "https://www.mxchip.com",
  120.                 "label": "X86C空气净化器中（2号）滤芯购买链接"
  121.             },
  122.             {
  123.                 "name": "link_24",
  124.                 "link": "https://www.mxchip.com",
  125.                 "label": "X86C空气净化器下（3号）滤芯购买链接"
  126.             },
  127.             {
  128.                 "name": "link_25",
  129.                 "link": "https://www.mxchip.com",
  130.                 "label": "智感模式说明"
  131.             },
  132.             {
  133.                 "name": "link_26",
  134.                 "link": "https://www.mxchip.com",
  135.                 "label": "X86空气净化器滤芯购买链接"
  136.             },
  137.             {
  138.                 "name": "link_27",
  139.                 "link": "https://www.mxchip.com",
  140.                 "label": "X86C空气净化器滤芯购买链接"
  141.             }
  142.         ]
  143.     }
  144. }
参数 类型 说明
name 字符串 链接名称
link 字符串 链接地址
label 字符串 链接描述

文件上传

文件上传

POST /api/upload

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }

参数：batch 请求方式：form-data 附件大小：<= 300kb

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "batch_path": "/public/img/xxx/jpg"
  6.     }
  7. }
参数 类型 说明
batch_path 字符串 附件地址

意见反馈

获取意见反馈类型列表

GET /api/feedback/category

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 1,
  12.                 "app_id": "",
  13.                 "created_at": "2018-12-26 17:40:25",
  14.                 "updated_at": "2018-12-26 17:40:25",
  15.                 "feedback_category_name": "其他",
  16.                 "feedback_category_description": ""
  17.             }
  18.         ]
  19.     }
  20. }
参数 类型 说明
created_at 字符串 数据存储时间
updated_at 字符串 数据更新时间
id 整型 数据唯一标识
feedback_category_name 字符串 反馈类型名称
feedback_category_description 字符串 反馈类型描述

获取意见反馈列表

GET /api/feedback

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
page 整型 可选 分页页数
size 整型 可选 一页数据数量

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 1,
  12.                 "app_id": "",
  13.                 "created_at": "2018-12-27 15:43:42",
  14.                 "updated_at": "2018-12-27 15:43:42",
  15.                 "feedback_content": "反馈内容",
  16.                 "feedback_status": 1,
  17.                 "feedback_category_id": 0,
  18.                 "contact_phone": "",
  19.                 "user_id": 3
  20.             }
  21.         ]
  22.     }
  23. }
参数 类型 说明
created_at 字符串 数据存储时间
updated_at 字符串 数据更新时间
id 整型 数据唯一标识
user_id 整型 用户唯一标识
feedback_content 字符串 反馈内容
feedback_status 整型 反馈状态：0待处理；1已处理
feedback_category_id 整型 反馈类型唯一标识
contact_phone 字符串 联系电话

删除意见反馈

DELETE /api/feedback/{feedback_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

添加意见反馈

POST /api/feedback

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
feedback_content 字符串 是 反馈内容
feedback_category_id 整型 可选 反馈类型id
contact_phone 字符串 可选 联系方式
app_version 字符串 可选 app版本
app_category 字符串 可选 app类型：ios, android

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.          "id": 1,
  6.         "app_id": "",
  7.         "created_at": "2018-12-27 15:43:42",
  8.         "updated_at": "2018-12-27 15:43:42",
  9.         "feedback_content": "反馈内容",
  10.         "feedback_status": 1,
  11.         "feedback_category_id": 0,
  12.         "contact_phone": "",
  13.         "user_id": 3
  14.     }
  15. }

获取意见反馈回复详情

GET /api/feedback/reply/{feedback_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  6.     }
  7. }

地理位置

同步app用户地理位置

POST /api/user/address

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
longitude 浮点型 是 经度
latitude 浮点型 是 纬度 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "_id": 4,
  6.         "longitude": 33.555,
  7.         "latitude": 33.333,
  8.         "detail": {},
  9.         "user_id": 2,
  10.         "date_time": "2019-01-03 16:41:21"
  11.     }
  12. }
参数 类型 说明
date_time 字符串 数据存储时间
_id 整型 数据唯一标识
longitude 浮点型 经度
latitude 浮点型 纬度
detail json 地理位置详情
user_id 整型 用户唯一标识

获取app用户地理位置

GET /api/user/address

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "_id": 4,
  6.         "longitude": 33.555,
  7.         "latitude": 33.333,
  8.         "detail": {},
  9.         "user_id": 2,
  10.         "date_time": "2019-01-03 16:41:21"
  11.     }
  12. }
参数 类型 说明
date_time 字符串 数据存储时间
_id 整型 数据唯一标识
longitude 浮点型 经度
latitude 浮点型 纬度
detail json 地理位置详情
user_id 整型 用户唯一标识

同步设备地理位置

POST /api/device/address

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
longitude 浮点型 是 经度
latitude 浮点型 是 纬度
iot_id 字符串 是 设备唯一标识 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "_id": 4,
  6.         "longitude": 33.555,
  7.         "latitude": 33.333,
  8.         "detail": {},
  9.         "iot_id": "xxxxxxxxx",
  10.         "date_time": "2019-01-03 16:41:21"
  11.     }
  12. }
参数 类型 说明
date_time 字符串 数据存储时间
_id 整型 数据唯一标识
longitude 浮点型 经度
latitude 浮点型 纬度
detail json 地理位置详情
iot_id 字符串 设备唯一标识

获取设备地理位置

GET /api/device/address/{iot_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "_id": 4,
  6.         "longitude": 33.555,
  7.         "latitude": 33.333,
  8.         "detail": {},
  9.         "iot_id": "xxxxxxxxx",
  10.         "date_time": "2019-01-03 16:41:21"
  11.     }
  12. }
参数 类型 说明
date_time 字符串 数据存储时间
_id 整型 数据唯一标识
longitude 浮点型 经度
latitude 浮点型 纬度
detail json 地理位置详情
iot_id 字符串 设备唯一标识

FAQ

获取FAQ列表

GET /api/faq

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
page 整型 可选 分页页数
size 整型 可选 一页数据数量
product_key 字符串 可选 产品key 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 2,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 2,
  12.                 "app_id": "",
  13.                 "created_at": "2019-01-29 10:36:04",
  14.                 "updated_at": "2019-04-30 10:45:49",
  15.                 "title": "使用说明",
  16.                 "content": "测试测试",
  17.                 "product_key": "a1JJL4qVSdo",
  18.                 "external_link": ""
  19.             }
  20.         ]
  21.     }
  22. }

获取FAQ详情

GET /api/faq/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "app_id": "",
  7.         "created_at": "2019-01-29 10:36:04",
  8.         "updated_at": "2019-04-30 10:45:49",
  9.         "title": "使用说明",
  10.         "content": "测试测试",
  11.         "product_key": "a1JJL4qVSdo",
  12.         "external_link": ""
  13.     }
  14. }

统计

（柱状图）设备纯废水统计(最近N小时/天/周/月)

GET /api/statistics/pure_waste_water

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备唯一标识
category 字符串 是 查询维度：hour(小时);day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/周/月 的数据量） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-01-14",
  8.                 "pure_water": 0,
  9.                 "waste_water": 0,
  10.                 "water_time": 0
  11.             }
  12.         ]
  13.     }
  14. }
参数 类型 说明
date_time 字符串 根据月，周，日，转换的对应的时间格式
pure_water 整型 纯水量
waste_water 整型 废水量
water_time 整型 制水时长

（曲线图）设备进出水统计

GET /api/statistics/one_pure_waste_water

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备唯一标识 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "_id": 0,
  8.                 "date_time": "2018-10-10 10:00:00",
  9.                 "start_time": "2018-10-10 09:00:00",
  10.                 "one_water_time": 20,
  11.                 "one_pure_water": 0,
  12.                 "one_waste_water": 0,
  13.                 "one_water": 0,
  14.                 "raw_water_tds": 3,
  15.                 "finished_water_tds": 1
  16.             }
  17.         ]
  18.     }
  19. }
参数 类型 说明
date_time 字符串 数据存储时间
start_time 字符串 开始制水时间
one_water_time 整型 制水时长（单位：秒）
one_pure_water 整型 纯水量
one_waste_water 整型 废水量
one_water 整型 进水量
raw_water_tds 整型 进水tds
finished_water_tds 整型 出水tds

（曲线图）设备温湿度统计(最近N小时/日/周/月)

GET /api/statistics/temperature_humidity

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备唯一标识
category 字符串 是 查询维度：hour(小时);day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/周/月 的数据量） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-04-17 12:00",
  8.                 "humidity": 54.46885245901639,
  9.                 "temperature": 23.39090909090909
  10.             },
  11.             {
  12.                 "date_time": "2019-04-17 13:00",
  13.                 "humidity": 0,
  14.                 "temperature": 0
  15.             },
  16.             {
  17.                 "date_time": "2019-04-17 14:00",
  18.                 "humidity": 0,
  19.                 "temperature": 0
  20.             },
  21.             {
  22.                 "date_time": "2019-04-17 15:00",
  23.                 "humidity": 44.64166666666667,
  24.                 "temperature": 26.7375
  25.             }
  26.         ]
  27.     }
  28. }
参数 类型 说明
date_time 字符串 根据月，周，日，转换的对应的时间格式
humidity 浮点型 平均湿度
temperature 浮点型 平均温度

（曲线图）设备PM25统计(最近N小时/日/周/月)

GET /api/statistics/pm25

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备唯一标识
category 字符串 是 查询维度：hour(小时);day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/周/月 的数据量） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-04-17 12:00",
  8.                 "pm25": 55
  9.             },
  10.             {
  11.                 "date_time": "2019-04-17 12:00",
  12.                 "pm25": 55
  13.             },
  14.             {
  15.                 "date_time": "2019-04-17 12:00",
  16.                 "pm25": 55
  17.             },
  18.             {
  19.                 "date_time": "2019-04-17 12:00",
  20.                 "pm25": 55
  21.             }
  22.         ]
  23.     }
  24. }
参数 类型 说明
date_time 字符串 根据月，周，日，转换的对应的时间格式
pm25 整型 PM2.5值

（曲线图）设备室外PM25统计(最近N小时/日/周/月)

GET /api/statistics/outdoor_pm25

（曲线图）设备甲醛浓度统计(最近N小时/日/周/月)

GET /api/statistics/hcho

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备唯一标识
category 字符串 是 查询维度：hour(小时);day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/周/月 的数据量） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-04-17 12:00",
  8.                 "hcho": 55
  9.             },
  10.             {
  11.                 "date_time": "2019-04-17 12:00",
  12.                 "hcho": 55
  13.             },
  14.             {
  15.                 "date_time": "2019-04-17 12:00",
  16.                 "hcho": 55
  17.             },
  18.             {
  19.                 "date_time": "2019-04-17 12:00",
  20.                 "hcho": 55
  21.             }
  22.         ]
  23.     }
  24. }
参数 类型 说明
date_time 字符串 根据月，周，日，转换的对应的时间格式
hcho 浮点型型 甲醛值

（曲线图）设备tvoc统计(最近N小时/日/周/月)

GET /api/statistics/tvoc

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备唯一标识
category 字符串 是 查询维度：hour(小时);day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/周/月 的数据量） 
  1. GET /api/statistics/tvoc?iot_id=Gso6EuIKwfJJPbSvuWVH000100&category=hour&size=3
  2. {
  3.     "code": 0,
  4.     "message": "success",
  5.     "data": {
  6.         "statistics": [
  7.             {
  8.                 "tvoc": 0.0,
  9.                 "date_time": "2020-02-27 08:00"
  10.             },
  11.             {
  12.                 "tvoc": 77.73154362416108,
  13.                 "date_time": "2020-02-27 09:00"
  14.             },
  15.             {
  16.                 "tvoc": 88.27835051546391,
  17.                 "date_time": "2020-02-27 10:00"
  18.             }
  19.         ]
  20.     }
  21. }

参数 类型 说明
date_time 字符串 根据月，周，日，转换的对应的时间格式
tvoc 浮点型型 tvoc均值

消息记录

获取推送记录列表

GET /api/push/message

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
page 整型 可选 分页页数
size 整型 可选 一页数据数量

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 3,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 3,
  12.                 "app_id": "",
  13.                 "created_at": "2019-03-08 16:12:28",
  14.                 "updated_at": "2019-03-08 16:12:28",
  15.                 "push_title": "一起来嗨皮",
  16.                 "push_body": "一起来嗨皮",
  17.                 "user_scope": "群推",
  18.                 "user_id": 12,
  19.                 "push_status": 1
  20.             },
  21.             {
  22.                 "id": 4,
  23.                 "app_id": "",
  24.                 "created_at": "2019-03-08 21:14:18",
  25.                 "updated_at": "2019-03-08 21:14:18",
  26.                 "push_title": "dfgdf",
  27.                 "push_body": "dfgdf",
  28.                 "user_scope": "指定用户",
  29.                 "user_id": 2,
  30.                 "push_status": 0
  31.             },
  32.             {
  33.                 "id": 5,
  34.                 "app_id": "",
  35.                 "created_at": "2019-03-15 14:18:49",
  36.                 "updated_at": "2019-03-15 14:18:49",
  37.                 "push_title": "春天到了，一起去浪啊",
  38.                 "push_body": "春天到了，一起去浪啊",
  39.                 "user_scope": "指定用户",
  40.                 "user_id": 12,
  41.                 "push_status": 0
  42.             }
  43.         ]
  44.     }
  45. }
参数 类型 说明
push_status 整型 0未读；1已读；2已删除

获取推送详情

GET /api/push/message/{push_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 3,
  6.         "app_id": "",
  7.         "created_at": "2019-03-08T16:12:28.475168",
  8.         "updated_at": "2019-03-08T16:12:28.475596",
  9.         "push_title": "一起来嗨皮",
  10.         "push_body": "一起来嗨皮",
  11.         "user_scope": "群推",
  12.         "user_id": 12,
  13.         "push_status": 1
  14.     }
  15. }

删除推送记录

DELETE /api/push/message/{push_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

批量删除推送记录

POST /api/push/message/group_delete

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
push_ids 字符串 是 push_id 英文逗号拼接的字符串

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

未读消息统计

GET /api/message/status

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "feedback": 0,
  6.         "push": 0,
  7.         "error": 0
  8.     }
  9. }

设备故障

获取用户设备未处理故障

GET /api/error/code

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "errors": [
  6.             {
  7.                 "_id": 1,
  8.                 "product_key": "a1JJL4qVSdo",
  9.                 "error_code": "PPRFIDErr",
  10.                 "iot_id": "OxOgpXQpphR8A3XqsXOm000100",
  11.                 "date_time": "2019-04-29T16:26:41.381000",
  12.                 "device_version": "2.0_Y100-0.20_Y100-1.37_EMW120"
  13.             }
  14.         ]
  15.     }
  16. }

根据设备获取设备未处理故障

GET /api/error/code/{iot_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "errors": [
  6.             {
  7.                 "_id": 1,
  8.                 "product_key": "a1JJL4qVSdo",
  9.                 "error_code": "PPRFIDErr",
  10.                 "iot_id": "OxOgpXQpphR8A3XqsXOm000100",
  11.                 "date_time": "2019-04-29T16:26:41.381000",
  12.                 "device_version": "2.0_Y100-0.20_Y100-1.37_EMW120"
  13.             }
  14.         ]
  15.     }
  16. }

阿里OSS服务

获取sts_token信息

GET /api/oss

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "RequestId": "B45B2931-05F9-40B4-BC86-9DC7BA188182",
  6.         "AssumedRoleUser": {
  7.             "AssumedRoleId": "344052235942587077:352img",
  8.             "Arn": "acs:ram::xxx:role/xxx/xxx"
  9.         },
  10.         "Credentials": {
  11.             "AccessKeySecret": "xxx",
  12.             "AccessKeyId": "STS.xxx",
  13.             "Expiration": "2019-05-22T04:33:23Z",
  14.             "SecurityToken": "+sbv/g1mWBogA99V172/PMpGQRw1tSywW2XzruRUgCUACEY4SdA="
  15.         },
  16.         "bucket_name": "3xxx",
  17.         "endpoint": "oss-cn-beijing.aliyuncs.com"
  18.     }
  19. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注