产品、发现、配网和查询API

更新时间：2019-12-06 16:23:12

概述

本文档说明APP端使用的品类产品、设备配网、用户设备相关的服务接口。

服务分为四部分：

品类产品服务

接口名	简介
查询品类	从APP端查询品类信息，支持全量、或根据父品类ID、或品类名称分页查询。
查询产品	从APP端分页查询产品信息，支持根据品类Key、或产品名、或产品Key查询。
查询设备	从APP端获取设备详情

设备发现服务

接口名	简介
查询零配设备	查询零配设备
过滤本地发现设备	过滤本地发现设备

设备绑定服务

接口名	简介
设备绑定	设备绑定
绑定WIFI设备	绑定WIFI设备。
绑定GPRS设备	绑定GPRS设备。
绑定ZIGBEE设备	绑定ZIGBEE设备。
绑定蓝牙设备	绑定蓝牙设备。

用户与设备服务

接口名	简介
查询用户绑定设备	查询用户绑定设备。

品类产品服务

查询品类

从APP端查询品类信息，支持全量、或根据父品类ID、或品类名称分页查询。

品类支持三级，一级品类的superId为0。

/home/app/category/query

当前版本 1.0.0

入参

字段名	类型	必填	备注
pageNo	Integer	是	页码
pageSize	Integer	是	页大小，最大100
superId	Integer	否	父品类ID 一级品类的superId为0 superId=-1时查询叶子品类列表。不传时从全量品类中筛选。
categoryName	String	否	品类名称

出参

返回结果使用通用结果类型封装，下表是通用结果类型中data域的详细说明

参数	类型	备注
pageNo	Integer	页码
pageSize	Integer	页大小，最大100
total	Integer	总记录数
data	JSONArray<Category>	品类列表

Cateogry 品类列表

参数	类型	备注
categoryId	String	品类ID
categoryName	String	品类名
categoryKey	String	品类键
superId	String	父品类ID 一级品类的superId=0。
imageUrl	String	品类图片
state	Integer	品类状态：0无效，1有效该值恒为1，可忽略

示例

查询一级品类列表

请求示例

{
    "pageNo":1,
    "pageSize":100,
    "superId":0
}

返回示例

{
    "id":"4de2c367-c1db-417c-aa15-8c585e595d92",
    "code":200,
    "message":null,
    "localizedMsg":null,
    "data":{
        "data":[
            {
                "categoryKey":"SmartLife",
                "state":1,
                "superId":0,
                "categoryName":"智能生活",
                "categoryId":274
            },
            {
                "categoryKey":"campus",
                "state":1,
                "superId":0,
                "categoryName":"智能园区",
                "categoryId":623
            },
            {
                "imageUrl":"url",
                "categoryKey":"SmartCity",
                "state":1,
                "superId":0,
                "categoryName":"智能城市",
                "categoryId":1
            },
            {
                "categoryKey":"SmartIndustry",
                "state":1,
                "superId":0,
                "categoryName":"智能工业",
                "categoryId":300
            }
        ],
        "pageNo":1,
        "pageSize":100,
        "total":4
    }
}

查询产品

从APP端分页查询产品信息，支持根据品类Key、或产品名、或产品Key查询。

/home/app/product/query

当前版本 1.0.0

入参

字段名	类型	必填	备注
pageNo	Integer	是	页码，范围 [1,∞]
pageSize	Integer	是	页大小，范围 [1,100]
categoryKey	String	否	查询精确匹配品类Key的产品信息
productName	String	否	查询模糊匹配产品名的产品信息
productKey	String	否	查询精确匹配产品Key的产品信息

出参

返回结果使用通用结果类型封装，下表是通用结果类型中data域的详细说明

参数	类型	备注
pageNo	Integer	页码
pageSize	Integer	页大小，最大100
total	Integer	总记录数
data	JSONArray<Product>	产品信息列表

product 产品信息

参数	类型	备注
productKey	String	产品key
productName	String	产品名称
productModel	String	产品设备型号
categoryName	String	品类名称
categoryKey	String	品类key
netType	String	入网类型：NET_WIFI
categoryUrl	String	品类图片
image	String	产品图片

示例

查询“智能门锁”这个品类的所有产品信息。

"智能门锁"的品类Key是"SmartDoor"，其父二级品类是“家居安防, HomeSecurity”，父一级品类是“智能生活, SmartLife”

请求示例

{
    "pageNo":1,
    "pageSize":100,
    "categoryKey":"SmartDoor"
}

返回示例

{
    "id":"xxx-xxx-xxx",
    "code":200,
    "message":null,
    "localizedMsg":null,
    "data":{
        "pageNo":1,
        "pageSize":100,
        "total":2,
        "data":[
            {
                "categoryKey":"SmartDoor",
                "categoryName":"智能门锁",
                "categoryUrl":"http://iotx-paas-admin.oss-cn-shanghai.aliyuncs.com/publish/image/1559631773685.png",
                "netType":"NET_CELLULAR",
                "productKey":"a1KqEIUeymg",
                "productModel":"Z30互联网款",
                "productName":"OSOT模型智能门锁"
            },
            {
                "categoryKey":"SmartDoor",
                "categoryName":"智能门锁",
                "categoryUrl":"http://iotx-paas-admin.oss-cn-shanghai.aliyuncs.com/publish/image/1559631773685.png",
                "image":"http://iotx-paas-admin.oss-cn-shanghai.aliyuncs.com/publish/image/1559631773685.png",
                "netType":"NET_ZIGBEE",
                "productKey":"a1yQvzUT66Z",
                "productModel":"DL130",
                "productName":"艾特_蓝光_智能门锁"
            }
        ]
    }
}

查询设备

从APP端获取设备详情

/home/app/device/get

当前版本 1.0.0

入参

字段名	类型	必填	备注
iotIdList	JSONArray	是	要查询的设备ID列表

出参

返回结果使用通用结果类型封装，data域是设备信息列表

参数	类型	备注
iotId	String	设备id
productImage	String	产品图片
deviceName	String	设备名称
nickName	String	设备昵称
productKey	String	产品key
productName	String	产品名
spaceId	String	空间Id
spaceName	String	空间名称
status	String	设备状态
isEdgeGateway	String	是否边缘网关
attributes	JSONList<Attribute>	属性值列表，属性定义见Attribute

Attribute 属性信息

参数	类型	备注
attribute	String	属性名
value	String	属性值

示例

建议一次查询一个设备信息

请求示例

{
    "iotIdList":["kvH36PwwtGaxxxx"]
}

返回示例

{
    "id":"4de2c367-c1db-417c-aa15-8c585e595d92",
    "code":200,
    "message":null,
    "localizedMsg":null,
    "data":[
        {
            "deviceName":"airXXX",
            "iotId":"kvH36PwwtGaxxxx",
            "isEdgeGateway":false,
            "productKey":"a19reu7MYBE",
            "productName":"空调",
            "status":1,
            "attributes":[
                {
                    "attribute":"PowerSwitch",
                    "value":"1"
                }
            ]
        }
    ]
}