[关闭]
@cfygaoyang 2018-03-23T03:39:14.000000Z 字数 12408 阅读 492

(金稻/杜亚/森太)接口文档

接口文档


用户注册

获取用户注册验证码

POST /enduser/getVerCode/

请求参数

参数 类型 必须 说明
loginname string 用户名
appid string FogCloud后台注册app时生成的id,如 35b0707e-78dd-11e7-bb3d-00163e085553

返回值

  1. {
  2. "meta": {
  3. "message": "Send message to phone successfully.",
  4. "code": 0
  5. },
  6. "data": {}
  7. }

错误码

错误代码 错误说明
10000 参数错误:参考Response中的message字段
10250 app id无效,在服务器找不到对应app
10050 内部错误
10750 未开通阿里大于短信的组件

验证码检查

POST /enduser/checkVerCode/

请求参数

参数 类型 必须 说明
appid string FogCloud后台注册app时生成的id,如 35b0707e-78dd-11e7-bb3d-00163e085553
loginname string 注册用的手机号码或者邮箱
vercode string 验证码

返回值

  1. {
  2. "meta": {
  3. "message": "signup ok",
  4. "code": 0
  5. },
  6. "data": {
  7. "token": "eyJhbGciOiJIUzI1N...",
  8. "clientid": "b6d21b047bed11e78d170016..."
  9. }
  10. }

字段说明

返回值字段 字段类型 字段说明
token string jwt token
clientid string 用户在服务器的唯一标识,同enduserid

错误码

错误代码 错误说明
10000 参数错误:参考Response中的message字段
10250 app id无效,在服务器找不到对应app
10252 用户被禁用
10300 验证码过期
10301 验证码错误
10050 服务器内部错误:缺少或者有多个MqttClient

用户登录

POST /enduser/login/

请求参数

参数 类型 必须 说明
loginname string 用户名
password string 密码
appid string 35b0707e-78dd-11e7-bb3d-00163e085553

返回值

  1. {
  2. "meta": {
  3. "message": "ok",
  4. "code": 0
  5. },
  6. "data": {
  7. "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbmR1c2VyaWQiOiI3ZGQ2NDJiYTc5MDYxMWU3YmIzZDAwMTYzZTA4NTU1MyIsIm9yaWdfaWF0IjoxNTAyNzA0NTMzLCJpZGVudGlmaWNhdGlvbiI6IjEzNTEwMjYwNTkxIiwiZXhwIjoxNTAzMzA5MzMzLCJhcHBpZCI6IjM1YjA3MDdlLTc4ZGQtMTFlNy1iYjNkLTAwMTYzZTA4NTU1MyJ9.5ozcuYuX03SHNSB41OmezZl_DQr9ymT_o6sEnwDXYpU",
  8. "clientid": "7dd642ba790611e7bb3d00163e085553"
  9. }
  10. }

字段说明

字段 类型 说明

刷新应用端授权

POST /enduser/refreshToken/

Headers

参数 必须 内容
Authorization JWT token

返回值

  1. {
  2. "meta": {
  3. "message": "ok",
  4. "code": 0
  5. },
  6. "data": {
  7. "token": "eyJhbGciOiJIUzI1N...",
  8. "clientid": "b6d21b047bed11e78d170016..."
  9. }
  10. }

字段说明

返回值字段 字段类型 字段说明
token string jwt token
clientid string 终端用户ID,同enduserid

错误码

错误代码 错误说明
10000 参数错误:缺少参数或者参数类型错误等
10101 token错误
10102 token已过刷新有效期,无法刷新
10250 token对应的用户没找到
10252 用户被禁用

验证应用端授权

POST /enduser/verifyToken/

Headers

参数 必须 内容
Authorization JWT token

返回值

  1. {
  2. "meta": {
  3. "message": "ok",
  4. "code": 0
  5. },
  6. "data": {
  7. "token": "eyJhbGciOiJIUzI1N...",
  8. "clientid": "b6d21b047bed11e78d170016..."
  9. }
  10. }

字段说明

返回值字段 字段类型 字段说明
token string jwt token
clientid string 终端用户ID,同enduserid

错误码

错误代码 错误说明
10000 参数错误:缺少参数或者参数类型错误等
10101 token错误
10102 token已过刷新有效期,无法刷新
10250 token对应的用户没找到
10252 用户被禁用

密码重置(jwt认证)

POST /enduser/resetPassword/

Headers

参数 必须 内容
Authorization JWT token
参数 类型 必须 说明
password1 string 密码,至少4个字符,最多20个字符
password2 string 确认密码,至少4个字符,最多20个字符

返回值

  1. {
  2. "meta": {
  3. "message": "Update password successfully.",
  4. "code": 0
  5. },
  6. "data": {}
  7. }

错误码

错误代码 错误说明
10000 参数错误:参考Response的message字段

用户信息

图片上传接口

POST /upload/img/

请求参数

参数 类型 必须 说明
img FILE 图片文件 png jpg gif

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "upload success"
  5. },
  6. "data": "jd.fogcloud.io/storage/img/20170727164915.png"
  7. }

字段说明

返回值字段 字段类型 字段说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示
data string 上传的可访问图片路径

更改头像接口

PUT /user/update_avatar/[enduserid]

请求参数

参数 类型 必须 说明
enduserid string 终端用户id
avatar string 图片url

返回值

  1. {
  2. "meta":{
  3. "message":"update success",
  4. "code":0
  5. },
  6. "data":{
  7. "avatar":"123.png"
  8. }
  9. }

字段说明

返回值字段 字段类型 字段说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示
avatar string 编辑的头像url

后台管理

用户登录获取Token

POST /get_token/

请求参数

参数 类型 必须 说明
username string 用户名
password string 密码

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "messsage": "success"
  5. },
  6. "data": {
  7. "token": "23cfbd8480c7c6737f05204a6ddb617c05faf8dd"
  8. }
  9. }

字段说明

返回值字段 字段类型 字段说明

产品信息

分页获取产品列表

GET /product/?page=[PAGE]

请求参数

参数 类型 必须 说明
page int 页数

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "find success"
  5. },
  6. "data": {
  7. "count": 2,
  8. "next": null,
  9. "previous": null,
  10. "results": [
  11. {
  12. "id": 1,
  13. "product_id": "123456",
  14. "product_name": "cao",
  15. "product_type": "1"
  16. },
  17. {
  18. "id": 2,
  19. "product_id": "qwert",
  20. "product_name": "wefgf",
  21. "product_type": "asdf"
  22. }
  23. ]
  24. }
  25. }

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求提示
count int 数据总条数
next string 下一页的链接
previous string 上一页的链接
results array 数据列表
id int 产品主键
product_id string SDS 产品 product_id
product_name string 产品名称
prodcut_type string 产品类型

备注

数据列表一页显示10条

添加产品

POST /product/

请求参数

参数 类型 必须 说明
product_id string SDS 产品 product_id
prodcut_name string 产品名称
prodcut_type string 产品类型

返回值

  1. {
  2. "meta":{
  3. "code" : 0,
  4. "message" : "insert success"
  5. },
  6. "data":{
  7. "id": 1,
  8. "product_id": "123456",
  9. "product_name": "cao",
  10. "product_type": "1"
  11. }
  12. }

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求提示
data json 添加的产品信息

根据产品主键(id)获取产品详情

GET /product/detail/[ID]

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "find success"
  5. },
  6. "data": {
  7. "id": 1,
  8. "product_id": "123456",
  9. "product_name": "cao",
  10. "product_type": "1"
  11. }
  12. }

字段说明

参数 类型 说明
code 整型 错误码;0代表正确,反之错误
message 字符串 请求提示
id 整型 产品主键
product_id 字符串 SDS 产品 product_id
product_name 字符串 产品名称
product_type 字符串 产品类型

编辑产品信息

PUT /product/detail/[ID]

请求参数

参数 类型 必须 说明
ID 整型 产品主键
product_id 字符串 SDS 产品 product_id
product_name 字符串 产品名称
product_type 字符串 产品类型

返回值

  1. {
  2. "meta": {
  3. "code" : 0,
  4. "message" : "update success"
  5. },
  6. "data": {
  7. "id": 4
  8. "product_id": "2345678",
  9. "product_name": "2345678",
  10. "product_type": "sdfghj"
  11. }
  12. }

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求提示
data json 编辑后的产品信息

删除产品

DELETE /product/detail/[ID]

返回值

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

字段说明

参数 类型 说明
code 整型 错误码;0代表正确,反之错误
message 字符串 请求提示

产品信息(APP)

分页获取产品列表

GET /product/api/?page=[PAGE]

请求参数

参数 类型 必须 说明
page int 页数

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "find success"
  5. },
  6. "data": {
  7. "count": 2,
  8. "next": null,
  9. "previous": null,
  10. "results": [
  11. {
  12. "id": 1,
  13. "product_id": "123456",
  14. "product_name": "cao",
  15. "product_type": "1"
  16. },
  17. {
  18. "id": 2,
  19. "product_id": "qwert",
  20. "product_name": "wefgf",
  21. "product_type": "asdf"
  22. }
  23. ]
  24. }
  25. }

参数说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求提示
count int 数据总条数
next string 下一页的链接
previous string 上一页的链接
results 数组 数据列表
id int 产品主键
product_id string SDS 产品 product_id
product_name string 产品名称
prodcut_type string 产品类型

备注

数据列表一页显示10条

根据产品主键(id)获取产品详情

GET /product/api/detail/[ID]

请求参数

参数 类型 必须 说明
ID int 产品主键

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "find success"
  5. },
  6. "data": {
  7. "id": 1,
  8. "product_id": "123456",
  9. "product_name": "cao",
  10. "product_type": "1"
  11. }
  12. }

参数说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示
id int 产品主键
product_id string SDS 产品 product_id
product_name string 产品名称
product_type string 产品类型

产品模板

分页查询产品模板列表

GET /product/template/?page=[PAGE]

请求参数

参数 类型 必须 说明
page int 页数

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "find success"
  5. },
  6. "data": {
  7. "count": 1,
  8. "next": null,
  9. "previous": null,
  10. "results": [
  11. {
  12. "id": 1,
  13. "template_name": "dfd",
  14. "template_json": "{\"name\":\"gaoyang\"}",
  15. "template_read": 23,
  16. "product": 1
  17. }
  18. ]
  19. }
  20. }

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求提示
count int 数据总条数
next string 下一页的链接
previous string 上一页的链接
results array 数据列表
id int 模板主键
template_name string 模板名称
template_json json 下发指令模板
template_read int 是否可更改;0代表 template_json 只读,反之可编辑
product int 产品主键

备注

数据列表一页显示10条

添加产品模板

POST /product/template/

请求参数

参数 类型 必须 说明
template_name string 模板名称
template_json json 下发指令模板
template_read int 模板是否只读;0代表template_json只读,反之可编辑
product int 产品主键

返回值

  1. {
  2. "meta": {
  3. "code" : 0,
  4. "message" : "insert success"
  5. },
  6. "data": {
  7. "id": 1,
  8. "template_name": "dfd",
  9. "template_json": "{\"name\":\"gaoyang\"}",
  10. "template_read": 23,
  11. "product": 1
  12. }
  13. }

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示
data json 添加的模板信息

根据模板主键(id)查询模板详情

GET /product/template/detail/[ID]

请求参数

参数 类型 必须 说明
ID int 模板主键

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "find success"
  5. },
  6. "data": {
  7. "id": 1,
  8. "template_name": "dfd",
  9. "template_json": "{\"name\":\"gaoyang\"}",
  10. "template_read": 23,
  11. "product": 1
  12. }
  13. }

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示
id int 模板主键 id
template_name string 模板名称
template_json json 下发指令模板
template_read int 是否可更改;0代表 template_json 只读,反之可编辑
product int 产品主键

编辑产品模板

PUT /product/template/detail/[ID]

请求参数

参数 类型 必须 说明
ID int 模板主键
template_name string 模板名称
template_json json 下发指令模板
template_read int 模板是否只读;0代表template_json只读,反之可编辑
product int 产品主键

返回值

  1. {
  2. "meta": {
  3. "code" : 0,
  4. "message" : "update success"
  5. },
  6. "data": {
  7. "id": 1234,
  8. "template_name": "sdfghjk",
  9. "template_json": "{\"name\":\"gaoyang\"}",
  10. "template_read": 0,
  11. "product": 1
  12. }
  13. }

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示
data json 编辑后的模板信息

删除产品模板

DELETE /product/template/detail/[ID]

请求参数

参数 类型 必须 说明
ID int 模板主键

返回值

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

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示

根据产品主键(id)查询产品模板列表

GET /product/template/[ID]

请求参数

参数 类型 必须 说明
ID int 产品主键

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "find success"
  5. },
  6. "data": {
  7. "count": 1,
  8. "next": null,
  9. "previous": null,
  10. "results": [
  11. {
  12. "id": 1,
  13. "template_name": "dfd",
  14. "template_json": "123",
  15. "template_read": 23,
  16. "product": 1
  17. }
  18. ]
  19. }
  20. }

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求提示
count int 数据总条数
next string 下一页的链接
previous strin 上一页的链接
results array 数据列表
id int 模板主键
template_name string 模板名称
template_json json 下发指令模板
template_read int 是否可更改;0代表 template_json 只读,反之可编辑
product int 产品主键

备注

数据列表一页显示10条

产品模板(APP)

根据模板主键(id)查询模板详情

GET /product/api/template/detail/[product_id]

请求参数

参数 类型 必须 说明
product_id string SDS model

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "find success"
  5. },
  6. "data": {
  7. "id": 1,
  8. "template_name": "dfd",
  9. "template_json": "{\"name\":\"gaoyang\"}",
  10. "template_read": 23,
  11. "product": 1
  12. }
  13. }

参数说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示
id int 模板主键 id
template_name string 模板名称
template_json json 下发指令模板
template_read int 是否可更改;0代表 template_json 只读,反之可编辑
product int 产品主键

根据产品主键(id)查询产品模板列表

GET /product/api/template/[ID]

请求参数

参数 类型 必须 说明
ID int 产品主键

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "find success"
  5. },
  6. "data": {
  7. "count": 1,
  8. "next": null,
  9. "previous": null,
  10. "results": [
  11. {
  12. "id": 1,
  13. "template_name": "dfd",
  14. "template_json": "123",
  15. "template_read": 23,
  16. "product": 1
  17. }
  18. ]
  19. }
  20. }

参数说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求提示
count int 数据总条数
next string 下一页的链接
previous string 上一页的链接
results array 数据列表
id int 模板主键
template_name string 模板名称
template_json json 下发指令模板
template_read int 是否可更改;0代表 template_json 只读,反之可编辑
product int 产品主键

备注

数据列表一页显示10条

设备

绑定设备同步厂商服务器

POST /device/api/

请求参数

参数 类型 必须 说明
end_user int 用户主键
device_id string 设备device_id
product_id string SDS产品product_id

返回值

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "insert success"
  5. },
  6. "data": {
  7. "id": 1,
  8. "end_user": "sdfghjk",
  9. "product_id": "23456789ihg",
  10. "device_id": "tyuiopsdfghj"
  11. }
  12. }

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示
data json 添加成功的数据

解绑设备同步厂商服务器

DELETE /device/api/{device_id}

Headers

参数 必须 内容
Authorization JWT token

请求参数

参数 类型 必须 说明
device_id string 设备device_id (数字和字符组成)

返回值

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

字段说明

参数 类型 说明
code int 错误码;0代表正确,反之错误
message string 请求消息提示

森太反馈接口

用户获取所有反馈

GET /feedback/message/

Headers

参数 必须 内容
Authorization JWT token

返回值

  1. {
  2. "meta": {
  3. "message": "查询成功。",
  4. "code": 0
  5. },
  6. "data": [
  7. {
  8. "id": 3,
  9. "user": "7dd642ba790611e7bb3d00163e085553",
  10. "phone": "334444",
  11. "datetime": "2017-08-10T17:47:01.525958",
  12. "content": "88444",
  13. "problem": "44",
  14. "device": "xxxxxxxxxxxx",
  15. "respond": false
  16. },
  17. {
  18. "id": 2,
  19. "user": "7dd642ba790611e7bb3d00163e085553",
  20. "phone": "111111111111",
  21. "datetime": "2017-08-10T17:37:56.707873",
  22. "content": "8888888",
  23. "problem": "888",
  24. "device": "8888888888888888888",
  25. "respond": false
  26. },
  27. {
  28. "id": 1,
  29. "user": "7dd642ba790611e7bb3d00163e085553",
  30. "phone": "13510260591",
  31. "datetime": "2017-08-10T17:29:31.527515",
  32. "content": "xfweaegadf",
  33. "problem": "sfaefawe",
  34. "device": "dsfadsgaeaegeaefe",
  35. "respond": true
  36. }
  37. ]
  38. }

字段说明

字段 类型 说明
user string enduser主键,enduserid
content string 反馈内容
problem string 问题类型
respond bool 是否被回复

用户反馈问题

POST /feedback/message/

Headers

参数 必须 内容
Authorization JWT token

请求参数

参数 类型 必须 说明
phone string 联系手机号
content string 反馈内容
problem string 问题类型
devcie string 设备ID

返回值

  1. {
  2. "meta": {
  3. "message": "添加成功。",
  4. "code": 0
  5. },
  6. "data": {
  7. "id": 5,
  8. "user": "7dd642ba790611e7bb3d00163e085553",
  9. "phone": "6666",
  10. "datetime": "2017-08-15T09:54:16.291976",
  11. "content": "test,test.",
  12. "problem": "11",
  13. "device": "xxxxxxxxxxxx",
  14. "respond": false
  15. }
  16. }

字段说明

字段 类型 说明

用户删除反馈问题

DELETE /feedback/message/

Headers

参数 必须 内容
Authorization JWT token

请求参数

参数 类型 必须 说明
record_id int 反馈记录主键

返回值

  1. {
  2. "meta": {
  3. "message": "删除成功。",
  4. "code": 0
  5. },
  6. "data": {}
  7. }

字段说明

字段 类型 说明

后台查询所有反馈问题

GET /feedback/messages/

返回值

  1. {
  2. "meta": {
  3. "message": "查询成功。",
  4. "code": 0
  5. },
  6. "data": [
  7. {
  8. "id": 3,
  9. "user": "7dd642ba790611e7bb3d00163e085553",
  10. "phone": "334444",
  11. "datetime": "2017-08-10T17:47:01.525958",
  12. "content": "88444",
  13. "problem": "44",
  14. "device": "xxxxxxxxxxxx",
  15. "respond": false
  16. },
  17. {
  18. "id": 2,
  19. "user": "7dd642ba790611e7bb3d00163e085553",
  20. "phone": "111111111111",
  21. "datetime": "2017-08-10T17:37:56.707873",
  22. "content": "8888888",
  23. "problem": "888",
  24. "device": "8888888888888888888",
  25. "respond": false
  26. },
  27. {
  28. "id": 1,
  29. "user": "7dd642ba790611e7bb3d00163e085553",
  30. "phone": "13510260591",
  31. "datetime": "2017-08-10T17:29:31.527515",
  32. "content": "xfweaegadf",
  33. "problem": "sfaefawe",
  34. "device": "dsfadsgaeaegeaefe",
  35. "respond": true
  36. }
  37. ]
  38. }

字段说明

字段 类型 说明

后台删除反馈问题

DELETE /feedback/messages/

请求参数

参数 类型 必须 说明
record_id int 反馈记录主键

返回值

  1. {
  2. "meta": {
  3. "message": "删除成功。",
  4. "code": 0
  5. },
  6. "data": {}
  7. }

字段说明

字段 类型 说明

查询反馈回复

GET /feedback/messageResponse/

请求参数

参数 类型 必须 说明
record_id int 反馈记录主键

返回值

  1. {
  2. "meta": {
  3. "message": "查询成功。",
  4. "code": 0
  5. },
  6. "data": [
  7. {
  8. "id": 5,
  9. "record": 1,
  10. "datetime": "2017-08-14T17:35:48.860838",
  11. "content": "多次尝试"
  12. }
  13. ]
  14. }

字段说明

字段 类型 说明
record int 反馈记录主键

后台回复反馈

POST /feedback/messageResponse/

请求参数

参数 类型 必须 说明
record int 反馈记录主键
content string 回复内容

返回值

  1. {
  2. "meta": {
  3. "message": "添加成功。",
  4. "code": 0
  5. },
  6. "data": {
  7. "id": 6,
  8. "record": 2,
  9. "datetime": "2017-08-15T10:09:15.729327",
  10. "content": "回复演示"
  11. }
  12. }

字段说明

字段 类型 说明
record int 反馈记录主键

后台删除反馈回复

DELETE /feedback/messageResponse/

请求参数

参数 类型 必须 说明
record_id int 回复记录主键

返回值

  1. {
  2. "meta": {
  3. "message": "删除成功。",
  4. "code": 0
  5. },
  6. "data": {}
  7. }

字段说明

字段 类型 说明

查询问题类型

GET /feedback/problemTypes/

返回值

  1. {
  2. "meta": {
  3. "message": "获取问题类型。",
  4. "code": 0
  5. },
  6. "data": [
  7. "设备使用问题",
  8. "APP使用出错",
  9. "设备配网问题",
  10. "功能与设计建议",
  11. "其他"
  12. ]
  13. }

字段说明

字段 类型 说明

查询FAQ

GET /feedback/FAQ/

返回值

  1. {
  2. "meta": {
  3. "message": "获取常见问题。",
  4. "code": 0
  5. },
  6. "data": [
  7. {
  8. "content": "确认是否联网,有没有断开设备。",
  9. "title": "设备为什么连接不成功?"
  10. },
  11. {
  12. "content": "可以换取礼品,只能在积分商城板块类目下可以使用。",
  13. "title": "怎么添加设备?"
  14. },
  15. {
  16. "content": "也可以接受手机热点的连接。",
  17. "title": "设备只能连接无线吗?"
  18. }
  19. ]
  20. }

字段说明

字段 类型 说明

获取设备数据记录

GET api/device_bsy_today/{enduserid}

GET api/device_bsy_week/{enduserid}

GET api/device_bsy_month/{enduserid}

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注