[关闭]
@cfygaoyang 2020-03-27T02:53:36.000000Z 字数 39038 阅读 1791

352 Web接口文档

错误码

错误码 信息 描述
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 验证码过期

账号体系

获取 token

POST /admin/auth/access_token

参数 类型 必须 说明
account 字符串 是 手机或邮箱
password 字符串 是 密码 
  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. }

刷新 token

POST /admin/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. }

销毁 token

POST /admin/auth/destroy_token

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

重置密码（token）

POST /admin/auth/reset_password

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

重置密码（old_password,password）

POST /admin/auth/reset_password_by_old_password

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

个人信息

获取个人信息

GET /admin/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.         "login_count": 21
  23.     }
  24. }

编辑个人信息

PUT /admin/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.         "login_count": 21
  23.     }
  24. }

配置管理

获取在线文档列表

GET /admin/document

  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-24 10:58:11",
  14.                 "updated_at": "2018-12-24 10:58:11",
  15.                 "name": "名称",
  16.                 "content": "内容",
  17.                 "path_name": "1",
  18.                 "url": "http://115.28.161.90:8003/document/1"
  19.             }
  20.         ]
  21.     }
  22. }

添加在线文档

POST /admin/document

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
name 字符串 是 文档名称
content 字符串 是 文档内容
path_name 字符串 可选 url 后缀名称

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.        "id": 1,
  6.         "app_id": "",
  7.         "created_at": "2018-12-24 10:58:11",
  8.         "updated_at": "2018-12-24 10:58:11",
  9.         "name": "名称",
  10.         "content": "内容",
  11.         "path_name": "1",
  12.         "url": "http://115.28.161.90:8003/document/1"
  13.     }
  14. }

获取在线文档详情

GET /admin/document/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.        "id": 1,
  6.         "app_id": "",
  7.         "created_at": "2018-12-24 10:58:11",
  8.         "updated_at": "2018-12-24 10:58:11",
  9.         "name": "名称",
  10.         "content": "内容",
  11.         "path_name": "1",
  12.         "url": "http://115.28.161.90:8003/document/1"
  13.     }
  14. }

编辑在线文档

PUT /admin/document/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
name 字符串 是 文档名称
content 字符串 是 文档内容
path_name 字符串 可选 url 后缀名称

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.        "id": 1,
  6.         "app_id": "",
  7.         "created_at": "2018-12-24 10:58:11",
  8.         "updated_at": "2018-12-24 10:58:11",
  9.         "name": "名称",
  10.         "content": "内容",
  11.         "path_name": "1",
  12.         "url": "http://115.28.161.90:8003/document/1"
  13.     }
  14. }

删除在线文档

DELETE /admin/document/{id}

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

获取App版本列表

GET /admin/app/version

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
page 整型 可选 分页页数
size 整型 可选 一页数据数量
app_type 字符串 可选 App 类型： android, ios 
  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": 1,
  12.                 "app_id": "",
  13.                 "created_at": "2018-10-09 00:00:00",
  14.                 "updated_at": "2018-10-09 00:00:00",
  15.                 "version_name": "安卓1.0.0",
  16.                 "version_number": "1.0.0",
  17.                 "version_description": "",
  18.                 "app_type": "android"
  19.             },
  20.             {
  21.                 "id": 2,
  22.                 "app_id": "",
  23.                 "created_at": "2018-10-09 00:00:00",
  24.                 "updated_at": "2018-10-09 00:00:00",
  25.                 "version_name": "苹果1.0.0",
  26.                 "version_number": "1.0.0",
  27.                 "version_description": "",
  28.                 "app_type": "ios"
  29.             }
  30.         ]
  31.     }
  32. }

添加App版本

POST /admin/app/version

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
app_type 字符串 是 App 类型： android, ios
version_name 字符串 是 版本名称
version_number 字符串 是 版本编号
version_description 字符串 可选 版本描述

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.        "id": 2,
  6.         "app_id": "",
  7.         "created_at": "2018-10-09 00:00:00",
  8.         "updated_at": "2018-10-09 00:00:00",
  9.         "version_name": "苹果1.0.0",
  10.         "version_number": "1.0.0",
  11.         "version_description": "",
  12.         "app_type": "ios"
  13.     }
  14. }

编辑App版本

PUT /admin/app/version/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
app_type 字符串 是 App 类型： android, ios
version_name 字符串 是 版本名称
version_number 字符串 是 版本编号
version_description 字符串 可选 版本描述

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.        "id": 2,
  6.         "app_id": "",
  7.         "created_at": "2018-10-09 00:00:00",
  8.         "updated_at": "2018-10-09 00:00:00",
  9.         "version_name": "苹果1.0.0",
  10.         "version_number": "1.0.0",
  11.         "version_description": "",
  12.         "app_type": "ios"
  13.     }
  14. }

删除App版本

DELETE /admin/app/version/{id}

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

添加/更新系统链接

POST /admin/system/links

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
link_1 字符串 是 系统链接
link_2 字符串 是 系统链接
link_3 字符串 是 系统链接
link_4 字符串 是 系统链接
link_5 字符串 是 系统链接
link_6 字符串 是 系统链接
link_7 字符串 是 系统链接
link_8 字符串 是 系统链接 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "links": [
  6.             {
  7.                 "name": "link_1",
  8.                 "link": "",
  9.                 "label": "加湿器滤网购买链接"
  10.             },
  11.             {
  12.                 "name": "link_2",
  13.                 "link": "",
  14.                 "label": "净水器滤芯购买链接"
  15.             },
  16.             {
  17.                 "name": "link_3",
  18.                 "link": "",
  19.                 "label": "净水器1号滤芯购买链接"
  20.             },
  21.             {
  22.                 "name": "link_4",
  23.                 "link": "",
  24.                 "label": "净水器2号滤芯购买链接"
  25.             },
  26.             {
  27.                 "name": "link_5",
  28.                 "link": "",
  29.                 "label": "352用户协议"
  30.             },
  31.             {
  32.                 "name": "link_6",
  33.                 "link": "",
  34.                 "label": "H60加湿器使用说明"
  35.             },
  36.             {
  37.                 "name": "link_7",
  38.                 "link": "",
  39.                 "label": "S80净水机使用说明"
  40.             },
  41.             {
  42.                 "name": "link_8",
  43.                 "link": "",
  44.                 "label": "配置失败"
  45.             },
  47.         ]
  48.     }
  49. }

获取系统链接

GET /admin/system/links

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "links": [
  6.             {
  7.                 "name": "link_1",
  8.                 "link": "",
  9.                 "label": "加湿器滤网购买链接"
  10.             },
  11.             {
  12.                 "name": "link_2",
  13.                 "link": "",
  14.                 "label": "净水器滤芯购买链接"
  15.             },
  16.             {
  17.                 "name": "link_3",
  18.                 "link": "",
  19.                 "label": "净水器1号滤芯购买链接"
  20.             },
  21.             {
  22.                 "name": "link_4",
  23.                 "link": "",
  24.                 "label": "净水器2号滤芯购买链接"
  25.             },
  26.             {
  27.                 "name": "link_5",
  28.                 "link": "",
  29.                 "label": "352用户协议"
  30.             },
  31.             {
  32.                 "name": "link_6",
  33.                 "link": "",
  34.                 "label": "H60加湿器使用说明"
  35.             },
  36.             {
  37.                 "name": "link_7",
  38.                 "link": "",
  39.                 "label": "S80净水机使用说明"
  40.             },
  41.             {
  42.                 "name": "link_8",
  43.                 "link": "",
  44.                 "label": "配置失败"
  45.             },
  46.             {
  47.                 "name": "link_9",
  48.                 "label": "Y100系统空气净化器说明书",
  49.                 "link":"http://115.28.161.90:8003/document/Y100"
  50.             },
  51.             {
  52.                 "name": "link_10",
  53.                 "label": "Y100系列购买链接",
  54.                 "link": "https://www.jd.com"
  55.             }
  56.         ]
  57.     }
  58. }

获取系统链接V2

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

更新系统链接V2

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

• 请求回调

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

获取开屏页/活动页

GET /admin/screen/page

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "screen_page": {
  6.             "id": 8,
  7.             "app_id": "",
  8.             "created_at": "2018-12-20 14:26:26",
  9.             "updated_at": "2018-12-20 14:26:26",
  10.             "picture": "xxxxxx",
  11.             "start_time": "2018-12-12 12:00:00",
  12.             "end_time": "2019-12-23 10:00:00",
  13.             "countdown": 3,
  14.             "category": 1,
  15.             "external_link": ""
  16.         },
  17.         "action_page": {
  18.             "id": 7,
  19.             "app_id": "",
  20.             "created_at": "2018-12-20 14:26:22",
  21.             "updated_at": "2018-12-20 14:26:22",
  22.             "picture": "xxxxxx",
  23.             "start_time": "2018-12-12 12:00:00",
  24.             "end_time": "2019-12-23 10:00:00",
  25.             "countdown": 3,
  26.             "category": 0,
  27.             "external_link": ""
  28.         }
  29.     }
  30. }
参数 类型 说明
picture 字符串 图片地址
start_time 字符串 有效起始时间
end_time 字符串 有效结束时间
countdown 字符串 倒计时（单位：秒）
category 字符串 类型（0:活动页，1:开屏页）
external_link 字符串 外部链接

添加开屏页/活动页

POST /admin/screen/page

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
picture 字符串 是 图片地址
start_time 字符串 是 有效起始时间
end_time 字符串 是 有效结束时间
countdown 字符串 可选 倒计时（单位：秒）
category 字符串 是 类型（0:活动页，1:开屏页）
external_link 字符串 是 外部链接 
  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.         "countdown": 3,
  10.         "picture": "xxxxxx",
  11.         "end_time": "2019-12-23 10:00:00",
  12.         "start_time": "2018-12-12 12:00:00",
  13.         "external_link": "",
  14.         "category": 1
  15.     }
  16. }

文件上传

文件上传

POST /admin/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. }

消息中心

添加意见反馈类型

POST /admin/feedback/category

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
feedback_category_name 字符串 是 反馈类型名称
feedback_category_description 字符串 可选 反馈类型描述 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 1,
  6.         "app_id": "",
  7.         "created_at": "2018-12-26 17:40:25",
  8.         "updated_at": "2018-12-26 17:40:25",
  9.         "feedback_category_name": "其他",
  10.         "feedback_category_description": ""
  11.     }
  12. }

获取意见反馈类型列表

GET /admin/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. }

编辑意见反馈类型

PUT /admin/feedback/category/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
feedback_category_name 字符串 是 反馈类型名称
feedback_category_description 字符串 可选 反馈类型描述 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 1,
  6.         "app_id": "",
  7.         "created_at": "2018-12-26 17:40:25",
  8.         "updated_at": "2018-12-26 17:40:25",
  9.         "feedback_category_name": "其他",
  10.         "feedback_category_description": ""
  11.     }
  12. }

删除意见反馈类型

DELETE /admin/feedback/category/{id}

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

获取意见反馈列表

GET /admin/feedback

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
page 整型 可选 分页页数
size 整型 可选 一页数据数量
start_time 字符串 可选 开始时间, 格式：2018-10-10 10:00:00
end_time 字符串 可选 开始时间, 格式：2018-10-10 10:00:00
username 字符串 可选 用户名
user_id 字符串 可选 反馈用户 id
feedback_content 字符串 可选 反馈内容模糊查询

* 请求回调

  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.                 "reply_time": "2018-12-27 15:43:42",
  16.                 "feedback_content": "反馈内容",
  17.                 "feedback_status": 1,
  18.                 "feedback_category_id": 0,
  19.                 "contact_phone": "",
  20.                 "user_id": 3,
  21.                 "feedback_category_name": "",
  22.                 "phone": "18656660930",
  23.                 "username": "18656660930",
  24.                 "feedback_reply_content": "回复内容",
  25.                 "reply_username": "admin"
  26.             }
  27.         ]
  28.     }
  29. }

删除意见反馈

DELETE /admin/feedback/{id}

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

回复意见反馈

POST /admin/feedback/reply

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
feedback_reply_content 字符串 是 回复内容
feedback_id 字符串 是 反馈id

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 1,
  6.         "app_id": "",
  7.         "created_at": "2018-12-27 17:21:29",
  8.         "updated_at": "2018-12-27 17:21:29",
  9.         "feedback_reply_content": "回复内容",
  10.         "feedback_id": 1,
  11.         "user_id": 2
  12.     }
  13. }

获取推送列表

GET /admin/push/log

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
page 整型 可选 分页页数
size 整型 可选 一页数据数量
start_time 字符串 可选 开始时间, 格式：2018-10-10 10:00:00
end_time 字符串 可选 开始时间, 格式：2018-10-10 10:00:00
username 字符串 可选 用户名 
  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-29 00:00:00",
  14.                 "updated_at": "2018-12-29 00:00:00",
  15.                 "push_title": "",
  16.                 "push_body": "推送内容",
  17.                 "user_scope": "指定用户",
  18.                 "user_id": 2,
  19.                 "username": "admin"
  20.             }
  21.         ]
  22.     }
  23. }

删除推送记录

DELETE /admin/push/log/{id}

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

后台管理

权限列表

POST /admin/user/permission

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "permissions": [
  6.             {
  7.                 "name": "permission_1",
  8.                 "value": false,
  9.                 "label": "查看筛选"
  10.             },
  11.             {
  12.                 "name": "permission_2",
  13.                 "value": false,
  14.                 "label": "推送消息"
  15.             },
  16.             {
  17.                 "name": "permission_3",
  18.                 "value": false,
  19.                 "label": "回复反馈"
  20.             },
  21.             {
  22.                 "name": "permission_4",
  23.                 "value": false,
  24.                 "label": "滤芯导出"
  25.             },
  26.             {
  27.                 "name": "permission_5",
  28.                 "value": false,
  29.                 "label": "配置管理"
  30.             },
  31.             {
  32.                 "name": "permission_6",
  33.                 "value": false,
  34.                 "label": "后台管理"
  35.             }
  36.         ]
  37.     }
  38. }

添加角色

POST /admin/user/role

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
role_name 字符串 是 角色名称
permissions 字符串 是 json 字符串 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "app_id": "",
  7.         "created_at": "2018-12-28 16:10:13",
  8.         "updated_at": "2018-12-28 16:10:13",
  9.         "role_name": "hello1",
  10.         "permissions": {
  11.             "a": 1
  12.         }
  13.     }
  14. }

获取角色列表

GET /admin/user/role

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  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": 1,
  12.                 "app_id": "",
  13.                 "created_at": "2018-12-28 16:01:11",
  14.                 "updated_at": "2018-12-28 16:01:11",
  15.                 "role_name": "hello",
  16.                 "permissions": {
  17.                     "a": 1
  18.                 }
  19.             },
  20.             {
  21.                 "id": 2,
  22.                 "app_id": "",
  23.                 "created_at": "2018-12-28 16:10:13",
  24.                 "updated_at": "2018-12-28 16:10:13",
  25.                 "role_name": "hello1",
  26.                 "permissions": {
  27.                     "a": 1
  28.                 }
  29.             }
  30.         ]
  31.     }
  32. }

编辑角色

PUT /admin/user/role/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
role_name 字符串 是 角色名称
permissions 字符串 是 json 字符串 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "app_id": "",
  7.         "created_at": "2018-12-28 16:10:13",
  8.         "updated_at": "2018-12-28 16:10:13",
  9.         "role_name": "hello1",
  10.         "permissions": {
  11.             "a": 1
  12.         }
  13.     }
  14. }

删除角色

DELETE /admin/user/role/{id}

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

新增账号

POST /admin/manager

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
username 字符串 是 用户名
password 字符串 是 密码
phone 字符串 是 手机
name 字符串 是 姓名
role 整型 是 角色 id 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "username": "jerry123",
  6.         "name": "jerry",
  7.         "phone": "18656660933",
  8.         "password": "123456",
  9.         "role": 2
  10.     }
  11. }

获取账号列表

GET /admin/manager

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  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": 6,
  12.                 "username": "jerry",
  13.                 "phone": "18656660931",
  14.                 "name": "jerry",
  15.                 "role_name": "hello1"
  16.             },
  17.             {
  18.                 "id": 7,
  19.                 "username": "jerry123",
  20.                 "phone": "18656660933",
  21.                 "name": "jerry",
  22.                 "role_name": "hello1"
  23.             }
  24.         ]
  25.     }
  26. }

编辑账号

PUT /admin/manager/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
username 字符串 是 用户名
password 字符串 是 密码
phone 字符串 是 手机
name 字符串 是 姓名
role 整型 是 角色 id 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "username": "jerry123",
  6.         "name": "jerry",
  7.         "phone": "18656660933",
  8.         "password": "123456",
  9.         "role": 2
  10.     }
  11. }

删除账号

DELETE /admin/manager/{id}

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

重置密码

POST /admin/manager/reset_password

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

操作日志

GET /admin/manager/handle/log

字段 类型 必须 说明
username string N username筛选用户名
handle_message string N 筛选 操作
created_at_lte string N 小于等于 %Y-%m-%d %H:%M:%S
created_at_gte string N 大于等于 %Y-%m-%d %H:%M:%S

* 请求header

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. GET /admin/manager/handle/log?page=1&size=20&username=啦啦&handle_message=更新开屏页&created_at_gte=2019-09-01 00:00:00&created_at_gte=2019-09-02 00:00:00
  3. {
  4.     "code": 0,
  5.     "message": "success",
  6.     "data": {
  7.         "total": 1,
  8.         "pages": 1,
  9.         "current_page": 1,
  10.         "page_size": 20,
  11.         "data": [
  12.             {
  13.                 "id": 20430,
  14.                 "app_id": "",
  15.                 "created_at": "2019-09-02 14:54:29",
  16.                 "updated_at": "2019-09-02 14:54:29",
  17.                 "user_id": 15,
  18.                 "user_role_id": 8,
  19.                 "handle_message": "更新开屏页",
  20.                 "username": "啦啦啦",
  21.                 "role_name": ""
  22.             }
  23.         ]
  24.     }
  25. }

用户中心

获取用户列表

GET /admin/user

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
page 整型 可选 分页页数
size 整型 可选 一页数据数量
start_time 字符串 可选 开始时间, 格式：2018-10-10 10:00:00
end_time 字符串 可选 开始时间, 格式：2018-10-10 10:00:00
username 字符串 可选 用户名 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 6,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 9,
  12.                 "username": "15502112361",
  13.                 "phone": "15502112361",
  14.                 "email": "",
  15.                 "register_time": "2019-01-02 16:09:55",
  16.                 "age": 0,
  17.                 "job": "",
  18.                 "name": "",
  19.                 "city": "",
  20.                 "company": "",
  21.                 "avatar": "",
  22.                 "birthday": "",
  23.                 "address": "",
  24.                 "nick_name": "",
  25.                 "sex": 2,
  26.                 "login_time": "",
  27.                 "login_ip": ""
  28.             },
  29.             {
  30.                 "id": 8,
  31.                 "username": "18516099125",
  32.                 "phone": "18516099125",
  33.                 "email": "",
  34.                 "register_time": "2018-12-29 17:09:42",
  35.                 "age": 0,
  36.                 "job": "",
  37.                 "name": "",
  38.                 "city": "",
  39.                 "company": "",
  40.                 "avatar": "",
  41.                 "birthday": "",
  42.                 "address": "",
  43.                 "nick_name": "",
  44.                 "sex": 2,
  45.                 "login_time": "",
  46.                 "login_ip": ""
  47.             },
  48.             {
  49.                 "id": 7,
  50.                 "username": "jerry123",
  51.                 "phone": "18656660933",
  52.                 "email": "",
  53.                 "register_time": "2018-12-28 16:58:10",
  54.                 "age": 0,
  55.                 "job": "",
  56.                 "name": "jerry",
  57.                 "city": "",
  58.                 "company": "",
  59.                 "avatar": "",
  60.                 "birthday": "",
  61.                 "address": "",
  62.                 "nick_name": "",
  63.                 "sex": 2,
  64.                 "login_time": "",
  65.                 "login_ip": ""
  66.             },
  67.             {
  68.                 "id": 6,
  69.                 "username": "jerry",
  70.                 "phone": "18656660931",
  71.                 "email": "",
  72.                 "register_time": "2018-12-28 16:57:51",
  73.                 "age": 0,
  74.                 "job": "",
  75.                 "name": "jerry",
  76.                 "city": "",
  77.                 "company": "",
  78.                 "avatar": "",
  79.                 "birthday": "",
  80.                 "address": "",
  81.                 "nick_name": "",
  82.                 "sex": 2,
  83.                 "login_time": "",
  84.                 "login_ip": ""
  85.             },
  86.             {
  87.                 "id": 3,
  88.                 "username": "18656660930",
  89.                 "phone": "18656660930",
  90.                 "email": "",
  91.                 "register_time": "2018-12-24 18:21:27",
  92.                 "age": 0,
  93.                 "job": "",
  94.                 "name": "",
  95.                 "city": "",
  96.                 "company": "",
  97.                 "avatar": "",
  98.                 "birthday": "",
  99.                 "address": "",
  100.                 "nick_name": "",
  101.                 "sex": 2,
  102.                 "login_time": "",
  103.                 "login_ip": ""
  104.             },
  105.             {
  106.                 "id": 2,
  107.                 "username": "admin",
  108.                 "phone": "18656660930",
  109.                 "email": "",
  110.                 "register_time": "2018-12-20 17:00:52",
  111.                 "age": 0,
  112.                 "job": "",
  113.                 "name": "",
  114.                 "city": "",
  115.                 "company": "",
  116.                 "avatar": "",
  117.                 "birthday": "",
  118.                 "address": "",
  119.                 "nick_name": "",
  120.                 "sex": 2,
  121.                 "login_time": "2019-01-04 11:49:31",
  122.                 "login_ip": "202.96.204.195"
  123.             }
  124.         ]
  125.     }
  126. }

获取用户详情

GET /admin/user/{id}

  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.         "login_count": 21
  23.     }
  24. }

FAQ

获取FAQ列表

GET /admin/faq

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

添加FAQ

POST /admin/faq

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
title 字符串 是 标题
content 字符串 是 内容
product_key 字符串 可选 产品唯一标识
external_link 字符串 可选 外链

获取FAQ详情

GET /admin/faq/{id}

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

编辑FAQ

PUT /admin/faq/{id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
title 字符串 是 标题
content 字符串 是 内容
product_key 字符串 可选 产品唯一标识
external_link 字符串 可选 外链

删除FAQ

DELETE /admin/faq/{id}

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

滤芯

获取滤芯种类列表

GET /admin/filter/category

  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": 2,
  12.                 "name":"TESTPP",
  13.                 "sn":"H070A",
  14.                 "date_time": "2019-01-03 11:37:37"
  15.             }
  16.         ]
  17.     }
  18. }

添加滤芯种类

POST /admin/filter/category

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
name 字符串 是 滤芯品类名称
sn 字符串 必须 滤芯开头5位sn, 必须5位 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "_id": 4,
  6.         "date_time": "2019-01-03 11:47:26",
  7.         "sn":"H070A",
  8.         "name":"TESTPP"
  9.     }
  10. }

删除滤芯种类

DELETE /admin/filter/category/{_id}

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

查询设备对应的滤芯信息列表

GET /admin/filter/element_by_device/{iot_id}

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

滤芯信息列表

GET /admin/filter/element

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
page 整型 可选 分页页数
size 整型 可选 一页数据数量
product_key 字符串 可选 产品唯一标识
country 字符串 可选 国家
province 字符串 可选 省
city 字符串 可选 市
district 字符串 可选 县/区
township 字符串 可选 街道
filter_type 字符串 可选 滤芯类型,滤芯SN前5位 ex: /admin/filter/element?filter_type=S080P
filter_position 字符串 可选 滤芯位置
filter_life_time_percent_start 整型 可选 最小寿命
filter_life_time_percent_end 整型 可选 最大寿命
mac 字符串 可选 mac或sn
filter_sn 字符串 可选 滤芯序列号 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 9,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "_id": 63,
  12.                 "items": {
  13.                     "FilterStatus_2": {
  14.                         "value": 0,
  15.                         "time": 1534299145344
  16.                     },
  17.                     "FinishedWaterTDS": {
  18.                         "value": 100,
  19.                         "time": 1534299145344
  20.                     },
  21.                     "FilterLifeTimePercent_2": {
  22.                         "value": 80,
  23.                         "time": 1534299145344
  24.                     },
  25.                     "FilterLifeTimeDays_2": {
  26.                         "value": 22.22,
  27.                         "time": 1534299145344
  28.                     },
  29.                     "RawWaterTDS": {
  30.                         "value": 500,
  31.                         "time": 1534299145344
  32.                     },
  33.                     "WaterTemperature": {
  34.                         "value": 22.33,
  35.                         "time": 1534299145344
  36.                     },
  37.                     "WorkState": {
  38.                         "value": 1,
  39.                         "time": 1534299145344
  40.                     },
  41.                     "PowerSwitch1": {
  42.                         "value": 74274,
  43.                         "time": 1534299145344
  44.                     },
  45.                     "FilterPosition": {
  46.                         "value": "",
  47.                         "time": 1547625606461
  48.                     },
  49.                     "FilterSN": {
  50.                         "value": "test6",
  51.                         "time": 1534299145344
  52.                     },
  53.                     "WasteWaterAdjustStatus": {
  54.                         "value": 1,
  55.                         "time": 1534299145344
  56.                     },
  57.                     "WaterDepletionStatus": {
  58.                         "value": 1,
  59.                         "time": 1534299145344
  60.                     },
  61.                     "HeatingStatus": {
  62.                         "value": 1,
  63.                         "time": 1534299145344
  64.                     },
  65.                     "OneTimeProducedWater": {
  66.                         "value": 50000,
  67.                         "time": 1534299145344
  68.                     },
  69.                     "FilterLife": {
  70.                         "value": "",
  71.                         "time": 1547625606461
  72.                     },
  73.                     "FilterType": {
  74.                         "value": "PP",
  75.                         "time": 1547625606461
  76.                     }
  77.                 },
  78.                 "date_time": "2019-01-16 15:26:44",
  79.                 "deviceName": "test6",
  80.                 "deviceType": "test001",
  81.                 "gmtCreate": 1534299145304,
  82.                 "iotId": "test6",
  83.                 "productKey": "a1JJL4qVSdo",
  84.                 "mac": "",
  85.                 "filter_element_type":"",
  86.                 "superuser_phone":""
  87.             }
  88.         ]
  89.     }
  90. }
参数 类型 说明
productKey 字符串 设备所属产品
deviceName 字符串 设备名称
iotId 字符串 设备唯一标识
deviceType 字符串 设备品类Key
gmtCreate 字符串 数据流转消息产生时间, 自1970-1-1起流逝的毫秒值
items JSON 变更的状态列表，列表元素包括：attribute - 变更属性, value - 变更值, time - 采样时间
FilterStatus_1 枚举型 滤芯寿命状态_1: 0 - 正常1 - 需要更换
FilterStatus_2 枚举型 滤芯寿命状态_2: 0 - 正常1 - 需要更换
FinishedWaterTDS 整数型 出水TDS: 取值范围：0 ~ 999 单位：ppm / 百万分率 步长：1
FilterLifeTimePercent_2 整数型 滤芯寿命百分比_2: 取值范围：0 ~ 100 单位：% / 百分比 步长：1
FilterLifeTimePercent_1 整数型 滤芯寿命百分比_1: 取值范围：0 ~ 100 单位：% / 百分比 步长：1
FilterLifeTimeDays_1 浮点型(双精度) 滤芯寿命天数_1: 取值范围：0 ~ 1100 单位：day / 日 步长：0.01
FilterLifeTimeDays_2 浮点型(双精度) 滤芯寿命天数_2: 取值范围：0 ~ 1100 单位：day / 日 步长：0.01
FilterSN 字符串 滤芯序列号
FilterPosition 字符串 滤芯位置
FilterType 字符串 滤芯类型
FilterLife 字符串 滤芯总寿命
mac 字符串 设备mac地址
filter_element_type 字符串 滤芯类型
superuser_phone 字符串 用户电话号码

滤芯信息详情

GET /admin/filter/element/{filter_sn}

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

地图

获取用户位置信息列表

GET /admin/user/address

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
username 字符串 可选 用户名
nick_name 字符串 可选 用户昵称

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "data": [
  6.             {
  7.                 "_id": 4,
  8.                 "longitude": 33.555,
  9.                 "latitude": 33.333,
  10.                 "detail": {},
  11.                 "user_id": 2,
  12.                 "date_time": "2019-01-03 16:41:21"
  13.             }
  14.         ]
  15.     }
  16. }

获取设备位置信息列表

GET /admin/device/address

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
product_key 字符串 可选 产品唯一标识
country 字符串 可选 国家
province 字符串 可选 省
city 字符串 可选 市
district 字符串 可选 县/区
township 字符串 可选 街道
status 字符串 可选 在离线状态：0离线1在线
is_bind 字符串 可选 是否已绑定
mac 字符串 可选 MAC地址
pipelined_code 字符串 可选 流水码
raw_water_min 字符串 可选 最小进水TDS
raw_water_max 字符串 可选 最大进水TDS
finished_water_min 字符串 可选 最小出水TDS
finished_water_max 字符串 可选 最大出水TDS
water_temperature_min 字符串 可选 最小水温
water_temperature_max 字符串 可选 最大水温

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "address": []
  6.     }
  7. }

产品

获取产品列表

GET /admin/product

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "product": [
  6.             {
  7.                 "product_key": "xxxxxx",
  8.                 "name": "352Water",
  9.                 "category_name": "净水器"
  10.             }
  11.         ]
  12.     }
  13. }

设备

设备信息列表

GET /admin/device/info

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
page 整型 可选 分页页数
size 整型 可选 一页数据数量
product_key 字符串 可选 产品唯一标识
country 字符串 可选 国家
province 字符串 可选 省
city 字符串 可选 市
district 字符串 可选 县/区
township 字符串 可选 街道
status 字符串 可选 在离线状态：0离线1在线
is_bind 字符串 可选 是否已绑定 1绑定0未绑定
mac 字符串 可选 MAC地址
pipelined_code 字符串 可选 流水码
raw_water_min 字符串 可选 最小进水TDS
raw_water_max 字符串 可选 最大进水TDS
finished_water_min 字符串 可选 最小出水TDS
finished_water_max 字符串 可选 最大出水TDS
water_temperature_min 字符串 可选 最小水温
water_temperature_max 字符串 可选 最大水温
user_id 整型 可选 绑定的管理员用户id
relative_humidity_min 字符串 可选 加湿器最小湿度
relative_humidity_max 字符串 可选 加湿器最大湿度
current_temperature_min 字符串 可选 加湿器最小温度
current_temperature_max 字符串 可选 加湿器最大温度
pm25_min 整型 可选 pm25 最小值
pm25_max 整型 可选 pm25 最大值
hcho_min 浮点型 可选 甲醛 最小值
hcho_max 浮点型 可选 甲醛 最大值
mcu_hardware_version 字符串 可选 硬件版本号 ex: /admin/device/info?mcu_hardware_version=Y100
order_by_pm25 整型 可选 1:正序小到大,-1:倒序:从大到小
order_by_hcho 整型 可选 1:正序小到大,-1:倒序:从大到小

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 0,
  6.         "pages": 0,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": []
  10.     }
  11. }

设备信息详情

GET /admin/device/info/{iot_id}

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

设备上下线日志

GET /admin/device/status/log/{iot_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
start_time 字符串 可选 开始时间：如 2018-10-10 10:00:00
end_time 字符串 可选 结束时间：如 2018-10-10 10:00:00

* 请求回调

设备日志

GET /admin/device/log/{iot_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
start_time 字符串 可选 开始时间：如 2018-10-10 10:00:00
end_time 字符串 可选 结束时间：如 2018-10-10 10:00:00

* 请求回调

设备绑定的用户

GET /admin/device/user/{iot_id}

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

设置设备流水码

PUT /admin/device/info/{iot_id}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
pipelined_code 字符串 可选 流水码

* 请求回调

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

设备详情PM25统计

参数 类型 必须 说明
iot_id 字符串 必选 流水码
category 字符串 必选 统计类别为 month, hour,day, week
size int 必选 统计条数

* 请求示例

请求最近4个月数据category=month,size=4

  1. GET /admin/device/statistics/pm25?iot_id=NtvnuDG7VGotVWa8fEsI000100&category=month&size=4
  3. {
  4.     "code": 0,
  5.     "message": "success",
  6.     "data": {
  7.         "statistics": [
  8.             {
  9.                 "date_time": "2019-05",
  10.                 "pm25": 0
  11.             },
  12.             {
  13.                 "date_time": "2019-06",
  14.                 "pm25": 0
  15.             },
  16.             {
  17.                 "date_time": "2019-07",
  18.                 "pm25": 0
  19.             },
  20.             {
  21.                 "date_time": "2019-08",
  22.                 "pm25": 3414.25
  23.             }
  24.         ]
  25.     }
  26. }
字段名 类型 说明
date_time string 时间字符串
pm25 float PM25值

设备详情HCHO统计接口

  1. GET /admin/device/statistics/hcho?iot_id=NtvnuDG7VGotVWa8fEsI000100&category=month&size=3
  2. {
  3.     "code": 0,
  4.     "message": "success",
  5.     "data": {
  6.         "statistics": [
  7.             {
  8.                 "date_time": "2019-06",
  9.                 "hcho": 0
  10.             },
  11.             {
  12.                 "date_time": "2019-07",
  13.                 "hcho": 0
  14.             },
  15.             {
  16.                 "date_time": "2019-08",
  17.                 "hcho": 1.0
  18.             }
  19.         ]
  20.     }
  21. }

设备详情tvoc统计

参数 类型 必须 说明
iot_id 字符串 必选 流水码
category 字符串 必选 统计类别为 month, hour,day, week
size int 必选 统计条数

* 请求示例

请求最近4个月数据category=month,size=4

  1. GET /admin/device/statistics/tvoc?iot_id=Gso6EuIKwfJJPbSvuWVH000100&category=month&size=4
  3. {
  4.     "code": 0,
  5.     "message": "success",
  6.     "data": {
  7.         "statistics": [
  8.             {
  9.                 "tvoc": 1049.7973289066665,
  10.                 "date_time": "2019-11"
  11.             },
  12.             {
  13.                 "tvoc": 778.6400838378637,
  14.                 "date_time": "2019-12"
  15.             },
  16.             {
  17.                 "tvoc": 834.827935748263,
  18.                 "date_time": "2020-01"
  19.             },
  20.             {
  21.                 "tvoc": 139.12386748278382,
  22.                 "date_time": "2020-02"
  23.             }
  24.         ]
  25.     }
  26. }
字段名 类型 说明
date_time string 时间字符串
tvoc float tvoc均值

设备硬件版本号接口

  1. GET /admin/hardware_version?type=mcu_hardware_version
  2. {
  3.     "code": 0,
  4.     "message": "success",
  5.     "data": [
  6.         "Y100"
  7.     ]
  8. }

天猫设备接口

--

获取天猫设备接口

参数 类型 必须 说明
mac string 否 mac过滤
status 字符串 可选 在离线状态：0离线 1在线
page 整型 可选 分页页数
size 整型 可选 一页数据数量

* response说明

参数 类型 说明
gmtModified Long 数据修改时间
activeTime Long 设备激活时间
gmtCreate Long 设备创建时间
productKey String 产品key
statusLast Integer 上一次设备状态
mac String mac地址
deviceSecret String 设备secret
iotId String 设备唯一标识符
name String 设备名称
nickname String 设备昵称
sdkVersion String sdk版本
sn String 设备sn
thingType String 设备类型
region String 区域
firmwareVersion String 固件版本号
rbacTenantId String 租户id
status Integer 设备状态 1 - 在线， 3 - 离线， 8 - 禁用

* 请求示例

  1. GET /admin/tmall_device?status=1&mac=fc:ee:e6:1a:5a:b2
  2. {
  3.     "code": 0,
  4.     "message": "success",
  5.     "data": {
  6.         "total": 811,
  7.         "pages": 41,
  8.         "current_page": 1,
  9.         "page_size": 20,
  10.         "data": [
  11.             {
  12.                 "gmtModified": 1561011028000,
  13.                 "activeTime": 1560856503762,
  14.                 "deviceKey": "H7cWwvNgIlEuQsCbZLME",
  15.                 "productKey": "a1sPQ2SRvUt",
  16.                 "statusLast": 3,
  17.                 "gmtCreate": 1555904208000,
  18.                 "mac": "fc:ee:e6:1a:5a:b2",
  19.                 "iotId": "H7cWwvNgIlEuQsCbZLME000100",
  20.                 "deviceSecret": "o8RxhbXyDoUFhQS4rGXDdo5bfjiAAkIo",
  21.                 "name": "H7cWwvNgIlEuQsCbZLME",
  22.                 "thingType": "DEVICE",
  23.                 "region": "cn-shanghai",
  24.                 "firmwareVersion": "1.38_S100-1.27_EMW120",
  25.                 "rbacTenantId": "12322895F67B451DA6E5AE3213AE748E",
  26.                 "status": 1
  27.             }
  28.         ]
  29.     }
  30. }

触发获取天猫设备数据

code 说明
0 获取天猫设备完成
10014 正在获取天猫设备数据，请稍后x

流水码上传功能

--

流水码模板地址

{{host}}/public/piplined_code.xlsx

流水码上传接口

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
pipeline 文件 是 上传的流水码文件，以表单方式上传

* 状态码说明

code 说明
10011 excel文件内容格式有误
10012 excel文件中的mac码格式有误, "MAC"字段是存在问题的MAC
10013 文件大小,小于300kb 
  1. {
  2.     "code": 10012,
  3.     "message": "mac format error.",
  4.     "data": {
  5.         "MAC": [
  6.             "asd009569D7E578"
  7.         ]
  8.     }
  9. }

统计

--

用户类型统计

GET /admin/statistics/user_app

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

新增用户统计(最近N小时/天/周/月)

GET /admin/statistics/user_add

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
category 字符串 是 查询维度：hour(小时); day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/月 的数据量） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "data": [
  6.             {
  7.                 "date_time": "2018-12-23",
  8.                 "count": 0
  9.             },
  10.             {
  11.                 "date_time": "2018-12-24",
  12.                 "count": 1
  13.             },
  14.             {
  15.                 "date_time": "2018-12-25",
  16.                 "count": 0
  17.             },
  18.             {
  19.                 "date_time": "2018-12-26",
  20.                 "count": 0
  21.             },
  22.             {
  23.                 "date_time": "2018-12-27",
  24.                 "count": 0
  25.             },
  26.             {
  27.                 "date_time": "2018-12-28",
  28.                 "count": 2
  29.             },
  30.             {
  31.                 "date_time": "2018-12-29",
  32.                 "count": 1
  33.             },
  34.             {
  35.                 "date_time": "2018-12-30",
  36.                 "count": 0
  37.             },
  38.             {
  39.                 "date_time": "2018-12-31",
  40.                 "count": 0
  41.             },
  42.             {
  43.                 "date_time": "2019-01-01",
  44.                 "count": 0
  45.             }
  46.         ],
  47.         "category": "day",
  48.         "size": 10
  49.     }
  50. }

新增用户统计(时间轴)

GET /admin/statistics/user_add_by_time_line

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
start_time 字符串 是 开始时间：如 2018-10-10
end_time 字符串 是 结束时间：如 2018-10-10 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "data": [
  6.             {
  7.                 "date_time": "2018-12-23",
  8.                 "count": 0
  9.             },
  10.             {
  11.                 "date_time": "2018-12-24",
  12.                 "count": 1
  13.             },
  14.             {
  15.                 "date_time": "2018-12-25",
  16.                 "count": 0
  17.             },
  18.             {
  19.                 "date_time": "2018-12-26",
  20.                 "count": 0
  21.             },
  22.             {
  23.                 "date_time": "2018-12-27",
  24.                 "count": 0
  25.             },
  26.             {
  27.                 "date_time": "2018-12-28",
  28.                 "count": 2
  29.             },
  30.             {
  31.                 "date_time": "2018-12-29",
  32.                 "count": 1
  33.             },
  34.             {
  35.                 "date_time": "2018-12-30",
  36.                 "count": 0
  37.             },
  38.             {
  39.                 "date_time": "2018-12-31",
  40.                 "count": 0
  41.             },
  42.             {
  43.                 "date_time": "2019-01-01",
  44.                 "count": 0
  45.             }
  46.         ],
  47.         "category": "day",
  48.         "size": 10
  49.     }
  50. }

设备在离线统计

GET /admin/statistics/device_status

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
product_key 字符串 可选 产品唯一标识

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "online": 0,
  6.         "offline": 0
  7.     }
  8. }

设备类型统计

GET /admin/statistics/device_category

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "product_key": "a1JJL4qVSdo",
  8.                 "name": "352Water",
  9.                 "category_name": "净水器",
  10.                 "count": 0
  11.             }
  12.         ]
  13.     }
  14. }

设备在线量统计

GET /admin/statistics/device_online

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
product_key 字符串 可选 产品唯一标识
category 字符串 是 查询维度：hour(小时); day(天); month(月)
size 整型 是 查询数量（最近多少 小时/天/月 的数据量）

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-01-18 01:00",
  8.                 "count": 0
  9.             },
  10.             {
  11.                 "date_time": "2019-01-18 02:00",
  12.                 "count": 0
  13.             },
  14.             {
  15.                 "date_time": "2019-01-18 03:00",
  16.                 "count": 0
  17.             },
  18.             {
  19.                 "date_time": "2019-01-18 04:00",
  20.                 "count": 0
  21.             },
  22.             {
  23.                 "date_time": "2019-01-18 05:00",
  24.                 "count": 0
  25.             },
  26.             {
  27.                 "date_time": "2019-01-18 06:00",
  28.                 "count": 0
  29.             },
  30.             {
  31.                 "date_time": "2019-01-18 07:00",
  32.                 "count": 0
  33.             },
  34.             {
  35.                 "date_time": "2019-01-18 08:00",
  36.                 "count": 0
  37.             },
  38.             {
  39.                 "date_time": "2019-01-18 09:00",
  40.                 "count": 0
  41.             },
  42.             {
  43.                 "date_time": "2019-01-18 10:00",
  44.                 "count": 0
  45.             }
  46.         ]
  47.     }
  48. }

设备活跃度统计(最近N小时/天/周/月)

GET /admin/statistics/device_active

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
product_key 字符串 可选 产品唯一标识
category 字符串 是 查询维度：hour(小时); day(天);week(周) month(月)
size 整型 是 查询数量（最近多少 小时/天/月 的数据量）

设备新增统计(最近N小时/天/周/月)

GET /admin/statistics/device_add

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
product_key 字符串 可选 产品唯一标识
category 字符串 是 查询维度：hour(小时); day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/月 的数据量） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-01-04",
  8.                 "count": 0
  9.             },
  10.             {
  11.                 "date_time": "2019-01-05",
  12.                 "count": 0
  13.             },
  14.             {
  15.                 "date_time": "2019-01-06",
  16.                 "count": 0
  17.             },
  18.             {
  19.                 "date_time": "2019-01-07",
  20.                 "count": 0
  21.             },
  22.             {
  23.                 "date_time": "2019-01-08",
  24.                 "count": 0
  25.             }
  26.         ]
  27.     }
  28. }

设备新增统计(时间轴)

GET /admin/statistics/device_add_by_time_line

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
product_key 字符串 可选 产品唯一标识
start_time 字符串 是 开始时间：如 2018-10-10
end_time 字符串 是 结束时间：如 2018-10-10

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-01-03",
  8.                 "count": 0
  9.             },
  10.             {
  11.                 "date_time": "2019-01-04",
  12.                 "count": 0
  13.             },
  14.             {
  15.                 "date_time": "2019-01-05",
  16.                 "count": 0
  17.             },
  18.             {
  19.                 "date_time": "2019-01-06",
  20.                 "count": 0
  21.             },
  22.             {
  23.                 "date_time": "2019-01-07",
  24.                 "count": 0
  25.             },
  26.             {
  27.                 "date_time": "2019-01-08",
  28.                 "count": 0
  29.             }
  30.         ]
  31.     }
  32. }

滤芯寿命统计(最近N天/周/月)

GET /admin/statistics/filter_life_time

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
filter_sn 字符串 是 滤芯序列号
category 字符串 是 查询维度：day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/月 的数据量） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-01-04",
  8.                 "filter_life_time": 100
  9.             },
  10.             {
  11.                 "date_time": "2019-01-05",
  12.                 "filter_life_time": 100
  13.             },
  14.             {
  15.                 "date_time": "2019-01-06",
  16.                 "filter_life_time": 100
  17.             },
  18.             {
  19.                 "date_time": "2019-01-07",
  20.                 "filter_life_time": 100
  21.             },
  22.             {
  23.                 "date_time": "2019-01-08",
  24.                 "filter_life_time": 100
  25.             },
  26.             {
  27.                 "date_time": "2019-01-09",
  28.                 "filter_life_time": 100
  29.             },
  30.             {
  31.                 "date_time": "2019-01-10",
  32.                 "filter_life_time": 100
  33.             },
  34.             {
  35.                 "date_time": "2019-01-11",
  36.                 "filter_life_time": 100
  37.             },
  38.             {
  39.                 "date_time": "2019-01-12",
  40.                 "filter_life_time": 100
  41.             },
  42.             {
  43.                 "date_time": "2019-01-13",
  44.                 "filter_life_time": 100
  45.             }
  46.         ]
  47.     }
  48. }

滤芯寿命统计(时间轴)

GET /admin/statistics/filter_life_time_by_time_line

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
filter_sn 字符串 是 滤芯序列号
start_time 字符串 是 开始时间：如 2018-10-10
end_time 字符串 是 结束时间：如 2018-10-10 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-01-04",
  8.                 "filter_life_time": 100
  9.             },
  10.             {
  11.                 "date_time": "2019-01-05",
  12.                 "filter_life_time": 100
  13.             },
  14.             {
  15.                 "date_time": "2019-01-06",
  16.                 "filter_life_time": 100
  17.             },
  18.             {
  19.                 "date_time": "2019-01-07",
  20.                 "filter_life_time": 100
  21.             },
  22.             {
  23.                 "date_time": "2019-01-08",
  24.                 "filter_life_time": 100
  25.             },
  26.             {
  27.                 "date_time": "2019-01-09",
  28.                 "filter_life_time": 100
  29.             },
  30.             {
  31.                 "date_time": "2019-01-10",
  32.                 "filter_life_time": 100
  33.             },
  34.             {
  35.                 "date_time": "2019-01-11",
  36.                 "filter_life_time": 100
  37.             },
  38.             {
  39.                 "date_time": "2019-01-12",
  40.                 "filter_life_time": 100
  41.             },
  42.             {
  43.                 "date_time": "2019-01-13",
  44.                 "filter_life_time": 100
  45.             }
  46.         ]
  47.     }
  48. }

设备进出水TDS统计(最近N天/周/月)

GET /admin/statistics/tds_water

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备唯一标识
category 字符串 是 查询维度：day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/月 的数据量） 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "date_time": "2019-01-04",
  8.                 "raw_water_tds": 0,
  9.                 "finished_water_tds": 0
  10.             },
  11.             {
  12.                 "date_time": "2019-01-05",
  13.                 "raw_water_tds": 0,
  14.                 "finished_water_tds": 0
  15.             }
  16.         ]
  17.     }
  18. }

设备水温统计(最近N天/周/月)

GET /admin/statistics/water_temperature

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
iot_id 字符串 是 设备唯一标识
category 字符串 是 查询维度：day(天);week(周); month(月)
size 整型 是 查询数量（最近多少 小时/天/月 的数据量）

进水TDS区间设备统计

GET /admin/statistics/tds_section/{product_key}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": [
  6.             {
  7.                 "section": "0-100",
  8.                 "count": 0
  9.             },
  10.             {
  11.                 "section": "101-200",
  12.                 "count": 0
  13.             },
  14.             {
  15.                 "section": "201-300",
  16.                 "count": 0
  17.             },
  18.             {
  19.                 "section": "401-99999999",
  20.                 "count": 0
  21.             }
  22.         ]
  23.     }
  24. }

滤芯统计

GET /admin/statistics/filter/{product_key}

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
product_key 字符串 可选 产品唯一标识

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "statistics": {
  6.             "a": 0,
  7.             "b": 0,
  8.             "c": 0
  9.         }
  10.     }
  11. }

加湿器温湿度统计(最近N小时/日/周/月)

GET /admin/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 浮点型 平均温度

移动推送

发起推送

POST /admin/push

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
title 字符串 是 推送标题
content 字符串 是 推送内容
push_target 字符串 是 device: 根据设备iot_id推送; user: 根据user_id推送; all: 推送所有人;device_region:指定设备地区推送;user_region:指定用户地区推送
target_value 字符串 可选 如果push_target为all, 可为空;如果push_target为device, 则为iot_id英文逗号拼接的字符串; 如果push_target为user, 则为user_id英文逗号拼接的字符串;当为push_target为device_region或user_region时,为GET params,例如:province=上海市&district=普陀区; 
  1. {
  2.     "push_target":"user_region",
  3.     "target_value":"province=上海市&district=普陀区",
  4.     "title":"sf",
  5.     "content":"sdf"
  6. }
  1. {
  2.     "code": 0, 
  3.     "message": "success",
  4.     "data": {}
  5. }

阿里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. }

水质地图接口

水质地图市县接口

GET /third/water/quality

参数 类型 必须 说明
type 字符串 是 县级取值 district，市级取值 city 
  1. {{host}}/third/water/quality?type=district
  1. {
  2.     "code": 1,
  3.     "message": "success",
  4.     "data": [
  5.         {
  6.             "TDS": 53.25,
  7.             "latitude": "114.246899",
  8.             "longitude": "22.720968",
  9.             "district": "龙岗区"
  10.         }
  11.     ]
  12. }

市级数据

  1. {{host}}/third/water/quality?type=city
  1. {
  2.     "code": 1,
  3.     "message": "success",
  4.     "data": [
  5.         {
  6.             "TDS": 53.25,
  7.             "latitude": "114.057868",
  8.             "longitude": "22.543099",
  9.             "district": "深圳市"
  10.         }
  11.     ]
  12. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注