[关闭]
@soszrg 2018-11-30T08:05:01.000000Z 字数 5222 阅读 416

产品模块接口文档

anxin

服务器地址

  1. http://121.40.214.215:8000

token格式

  1. Authorization:  token d79be1d657d9a8b45f6f903620e84b06cbf225e0
  1. 获取产品类别列表(token)

ErrorCode说明

code 说明
10100 access token过期
10101 access token错误
10102 refresh token错误或过期

参数说明

获取产品类别列表(token)

接口地址

GET /api/v1/product/category/

请求参数示例

  1.  GET /api/v1/product/category/

返回参数

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "ok"
  5.     },
  6.     "data": [
  7.         {
  8.             "name": "配电箱",
  9.             "id": 1,
  10.         },
  11.         {
  12.             "name": "水表",
  13.             "code": "18011"
  14.             "id": 2,
  15.         }
  16.     ]
  17. }

返回参数说明

参数 类型 说明
name varchar 类别名称
id int 类别id

创建产品(token)

接口地址

POST /api/v1/product/products/

请求参数示例

  1. > POST /api/v1/product/products/
  2. {
  3.     "name":"test3",
  4.     "model":"model3",
  5.     "category":1,
  6.     "extra":{"k1":"v1"},
  7.     "description":"xxx",
  8.     "gateway_type": 2,
  9.     "network":0
  10. }

**请求参数说明

参数 类型 必须 说明
name varchar Y 产品名称
model varchar Y 产品型号
gateway_type int N 设备类型
description varchar N 产品描述
category int Y 产品所属类别id
extra json N 产品其他信息
network int N 设备联网方式，默认为0（有线）

设备联网方式说明

value 联网方式
0 有线
1 WIFI
2 4G
3 有线和WIFI
4 有线和4G

返回参数示例

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"create new product ok"
  5.     },
  6.     "data":{
  7.         "name":"test3",
  8.         "model":"model3",
  9.         "description":"xxx",
  10.         "category":1,
  11.         "extra":{
  12.             "k1":"v1"
  13.         },
  14.         "product_id":"c374be33010c...",
  15.         "status":0,
  16.         "iot_key":"",
  17.         "created_at":"2018-11-12T22:27:57",
  18.         "category_info":{
  19.             "id":1,
  20.             "name":"智能电箱"
  21.         },
  22.         "gateway_type":2，
  23.         "network": 1
  24.     }
  25. }

返回参数说明

参数 类型 说明
name varchar 产品名称
model varchar 产品型号
description varchar 产品描述
category int 产品所属类别id
extra json 产品其他信息
product_id varchar 产品id
status int 0 1分别表示开发 上线三种状态
iot_key varchar 阿里云物联网平台对应的Product key
created_at datetime 创建时间

获取单个产品信息(token)

接口地址

GET /api/v1/product/products/[product_id]/

请求参数示例

  1. > GET /api/v1/product/products/7d690eaea376a7ec6ac92dd9e6a0e0/

返回参数示例

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"product info"
  5.     },
  6.     "data":{
  7.         "name":"test1",
  8.         "model":"model1",
  9.         "description":"xxx",
  10.         "category":1,
  11.         "extra":{
  12.         },
  13.         "product_id":"e2d176c04b6...",
  14.         "status":0,
  15.         "iot_key":"a1oPk8u75qm",
  16.         "created_at":"2018-11-12T17:08:41",
  17.         "category_info":{
  18.             "id":1,
  19.             "name":"智能电箱"
  20.         },
  21.         "gateway_type":0,
  22.         "network": 1
  23.     }
  24. }

返回参数说明

参数 类型 说明
name varchar 产品名称
model varchar 产品型号
description varchar 产品描述
category int 产品所属类别id
extra json 产品其他信息
product_id varchar 产品id
status int 0 1分别表示开发 上线三种状态
iot_key varchar 阿里云物联网平台对应的Product key
category_info.name varchar 产品类别名字
category_info.id int 产品类别id
created_at datetime 创建时间

更新产品信息(token)

接口地址

PUT /api/v1/product/products/[product_id]

请求参数示例

  1. > PUT /api/v1/product/products/a6847200c65997df98767dc927c4e3/
  2. {
  3.     "name":"test3",
  4.     "model":"model3",
  5.     "category":1,
  6.     "extra":{"k1":"v1"},
  7.     "description":"xxx",
  8.     "gateway_type": 2,
  9.     "network": 0
  10. }

**请求参数说明

参数 类型 必须 说明
name varchar Y 新产品名称（不可以和原先一样）
model varchar Y 新产品型号（不可以和原先一样）
description varchar N 新产品描述
category int Y 产品所属类别id
extra json N 产品其他信息
gateway_type int 设备类型
network int 设备联网方式

返回参数示例

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "update product info ok"
  5.     },
  6.     "data": [
  7.         {
  8.          "name": "ele2",
  9.         "model": "anxin2",
  10.         "description": null,
  11.         "category": 2,
  12.         "extra": {
  13.          "a": "a"
  14.         },
  15.         "product_id": "6b18683e2b2e2b092f1000c5ff8a50",
  16.         "status": 0,
  17.         "iot_key": "a10qOlk6wVu",
  18.         "network": 0
  19.         "created_at": "2018-08-31T14:51:51"
  20.         }
  21.     ]
  22. }

返回参数说明

参数 类型 说明
name varchar 产品名称
model varchar 产品型号
description varchar 产品描述
category int 产品所属类别id
extra json 产品其他信息
product_id varchar 产品id
status int 0 1分别表示开发 上线三种状态
iot_key varchar 阿里云物联网平台对应的Product key
created_at datetime 创建时间

获取产品列表(token)

接口地址

GET /api/v1/product/products/

请求参数示例

  1. > GET /api/v1/product/products/

返回参数示例

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"product list"
  5.     },
  6.     "data":[
  7.         {
  8.             "name":"test1",
  9.             "model":"model1",
  10.             "description":"xxx",
  11.             "category":1,
  12.             "extra":{
  13.             },
  14.             "product_id":"45f2651c4131...",
  15.             "gateway_type": 0,
  16.             "network": 1,
  17.             "status":0,
  18.             "iot_key":"a1GEGf9j2Fb",
  19.             "created_at":"2018-11-12T17:20:45",
  20.             "category_info":{
  21.                 "id":1,
  22.                 "name":"电柜"
  23.             }
  24.         },
  25.         {
  26.             "name":"test2",
  27.             "model":"model2",
  28.             "description":"xxx",
  29.             "category":1,
  30.             "extra":{
  31.             },
  32.             "product_id":"5eb458fd3...",
  33.             "gateway_type":2,
  34.             "network": 1
  35.             "status":0,
  36.             "iot_key":"a1I1ZJmnq8F",
  37.             "created_at":"2018-11-12T17:20:10",
  38.             "category_info":{
  39.                 "id":2,
  40.                 "name":"智能水表"
  41.             }
  42.         }
  43.     ]
  44. }

返回参数说明

参数 类型 说明
name varchar 产品名称
model varchar 产品型号
description varchar 产品描述
category int 产品所属类别id
extra json 产品其他信息
product_id varchar 产品id
gateway_type int 设备类型：0 1 2分别为普通设备，网关设备，子设备
status int 0 1分别表示开发 上线状态
iot_key varchar 阿里云物联网平台对应的Product key
category_info.name varchar 产品类别名字
category_info.id int 产品类别id
created_at datetime 创建时间

产品删除(token)

接口地址

DELETE /api/v1/product/products/[product_id]

请求参数示例

  1. > DELETE /api/v1/product/products/a6847200c65997df98767dc927c4e3/

返回参数示例 

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

设备列表(token)

接口地址

GET /api/v1/product/[product_id]/devices

请求参数示例

  1. > GET/api/v1/product/a6847200c65997df98767dc927c4e3/devices/

返回参数示例 

  1. {
  2.     "meta":{
  3.         "message":"info list",
  4.         "code":0
  5.     },
  6.     "data":{
  7.         "count":1,
  8.         "page_size":10,
  9.         "next":null,
  10.         "previous":null,
  11.         "results":[
  12.             {
  13.                 "device_id":"a4071bcc45c898...",
  14.                 "dsn":"zrgtest18111301",
  15.                 "is_online":false
  16.             }
  17.         ]
  18.     }
  19. }

返回参数说明

参数 类型 说明
count int 总数
page_size int 每页item数
next varchar 下一页
previous varchar 上一页
results array 数据
device_id varchar 设备id
dsn varchar mac地址
is_online boolean 设备是否在线

产品上线(token)

接口地址

PUT /api/v1/product/[product_id]/status/

请求参数示例

  1. > PUT /api/v1/product/a6847200c65997df98767dc927c4e3/status/
  2. {
  3.     "status":1 
  4. }

**请求参数说明

参数 类型 必须 说明
status int Y 产品状态：1 上线，0 开发中

返回参数示例

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "update product status info ok"
  5.     },
  6.     "data": {
  7.     }
  8. }

返回参数说明
无

产品名list(token)

接口地址

GET /api/v1/product/names/

请求参数示例

  1. > GET /api/v1/product/names/?category_id=1
  2. {
  3. }

**请求参数说明

参数 类型 必须 说明
status int Y 产品类型

返回参数示例

  1. {
  2.     "meta":{
  3.         "message":"info list",
  4.         "code":0
  5.     },
  6.     "data":{
  7.         "count":9,
  8.         "page_size":10,
  9.         "next":null,
  10.         "previous":null,
  11.         "results":[
  12.             {
  13.                 "product_id":"c374be33010cd4944a476a0a788a17",
  14.                 "name":"test3"
  15.             },
  16.             {
  17.                 "product_id":"9be5cd80f388f00ff784c86b687849",
  18.                 "name":"zrgtest"
  19.             }
  20.         ]
  21.     }
  22. }

返回参数说明
无

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