单品设备配网服务API

更新时间：2020-03-13 10:13:55

/thing/gateway/permit

path 版本 描述 是否需要用户身份的鉴权
/thing/gateway/permit 1.0.2 允许网关处理子设备接入的请求 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
iotId String 是 网关设备iotId
productKey String 是 允许接入网关的子设备产品标识符
time Integer 是 接入时间窗口，单位：秒

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "iotId": "xxxxxxxxxxxxxx",
        "productKey": "xxxxxxxxx", 
        "time": 60                   
    }
}


正常返回示例

{
    "id":"xxx",
    "code":200,
    "message":"success",
    "data":null
}

/thing/allProductInfo/getByProductKey

path 版本 描述 是否需要登陆
/thing/allProductInfo/getByProductKey 1.1.3 根据ProductKey查询产品信息 否

请求参数

参数 类型 必填 描述
productkey String 是 产品Key

返回参数

参数 类型 必有 描述
productKey String 是 产品PK
dataFormat String 是 数据格式
CUSTOM_FORMAT:透传/自定义格式,
ALINK_FORMAT:Alink协议
netType String 是 入网类型
NET_LORA:lora网络,
NET_WIFI:Wi-Fi网络,
NET_ZIGBEE:Zigbee网络,
NET_BT:蓝牙,
NET_CELLULAR:GPRS,
NET_ETHERNET:以太网,
NET_OTHER:其他
productSecret String 否 产品密钥
nodeType String 是 节点类型
DEVICE:设备,
GATEWAY:网关
domain String 否 产品域
name String 是 产品名称
region String 是 地域
ownerDomain String 否 所有者领域
categoryId Long 是 归属品类id
categoryKey String 否 品类标识符
categoryName String 否 品类名称
accessMethod String 是 访问方式
DATA_DIRECT: 数据直连,
AIR_FORWARD: 空中转发,
APP: APP，
VIRTUAL: 虚拟设备
status String 否 产品状态
DEVELOPMENT_STATUS:开发中,
RELEASE_STATUS:已发布
gmtCreate Date 是 创建时间
gmtModified Date 是 修改时间
creator String 是 创建者
modifier String 是 修改者
productId Long 是 产品Id
aliyunCommodityCode String 否 商品码
connectMode String 是 配网方式
rbacTenantId String 是 租户id

示例
请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.3",
        "iotToken": "token"
    },
    "params": {
        "productKey": "a1eaZKTdVAH"
    }
}

正常返回示例

{
    "code": 200,
    "data": {
        "accessMethod": "DATA_DIRECT",
        "gmtModified": 1517217645000,
        "modifier": "5030ala9cd2091d851a80fbdc63b454243668090",
        "productKey": "a1I0TQKlMCW",
        "creator": "5030ala9cd2091d851a80fbdc63b454243668090",
        "productId": 87634,
        "dataFormat": "ALINK_FORMAT",
        "netType": "NET_WIFI",
        "aliyunCommodityCode": "tmp",
        "productSecret": "tfbMocigfRPqPKKj",
        "nodeType": "DEVICE",
        "gmtCreate": 1517208303000,
        "domain": "a1I0TQKlMCW",
        "name": "风扇",
        "tenantId": 3312,
        "connectMode": "2,3",
        "region": "cn-shanghai",
        "ownerDomain": "tmp_5030ala9cd2091d851a80fbdc63b454243668090",
        "rbacTenantId": "755ED7C7810B4255BA026BBC48BF0247",
        "categoryId": 285,
        "status": "RELEASE_STATUS"
    },
    "id": "6aad0b12-2192-4b90-8f40-08a2bc0b5c2a"
}

/awss/enrollee/product/filter

path 版本 描述 是否需要用户 身份的鉴权
/awss/enrollee/product/filter 1.0.2 根据过滤规则从客户端通过本地通讯发现的本地设备列表中，过滤出还未被用户绑定的设备信息 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
iotDevices List 是 本地发现的设备信息列表

列表结构

字段名 字段类型 必填 详细描述
productKey String 是 产品PK
deviceName String 是 设备名称(deviceNmae)

返回参数

参数 类型 必有 描述
productKey String 是 产品PK（与入参一致）
deviceName String 是 设备名称(与入参一致)
productName String 是 产品名称
netType Integer 是 入网类型 (0:LORA,3:WIFI,4:ZIGBEE,5:BT,6:CELLULAR,7:ETHERNET,8:NET_OTHER)
nodeType Integer 是 节点类型 (0:DEVICE,1:GATEWAY)
categoryKey String 是 品类标识符
categoryName String 是 品类名称
categoryId Long 是 归属品类id

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": [{
        "productKey": "a1v12d34vm"，
        "deviceName": "xxxxxx"
    },
    {
        "productKey": "a1v12d77bb"，
        "deviceName": "xxxxxx"
    }]
}

正常返回示例

{
    "code": 200,
    "data":[
            {
                "productKey":"a1v12d34vm",
                "deviceName":"xxxxxx",
                "netType":3,
                "nodeType":0,
                "categoryKey":"xxx",
                "categoryName":"xxx",
                "categoryId":14
            }
    ],
    "message": "success"
}

/awss/enrollee/guide/get

path 版本 描述 是否需要用户身份的鉴权
/awss/enrollee/guide/get 1.1.3 查询配网引导页的模版定义信息，用于客户端展示友好的配网流程的引导信息 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
productKey String 是 productKey

返回参数

参数 类型 必有 描述
productKey String 是 产品Key
helpTitle String 否 帮助标题
dnGuideIcon String 否 配网引导图标
helpCopywriting String 否 帮助文案
buttonCopywriting String 否 按钮文案
dnCopywriting String 否 配网文案
helpIcon String 否 帮助图标
id Long 是 配网引导id
gmtCreate Date 是 创建时间
gmtModified Date 是 修改时间
creator String 是 创建者
modifier String 是 修改者
rbacTenantId String 是 rbac租户Id

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.3",
        "iotToken": "token"
    },
    "params": {
        "productKey": "a1eaZKTdVAH"
    }
}


正常返回示例

{
    "code": 200,
    "data": [{
        "gmtModified": 1517476367000,
        "creator": "755ED7C7810B4255BA026BBC48BF0247",
        "helpTitle": "指示灯没有闪烁？",
        "dnGuideIcon": "http://iotx-ilop.oss-cn-hangzhou.aliyuncs.com/iotx-ilop-portal/p/a124FzVD7BCP4Qfi/networkConfig/1517476344732/timg.jpg",
        "helpCopywriting": "请长按重置3-5秒，确保看到指示灯闪烁后松开",
        "modifier": "755ED7C7810B4255BA026BBC48BF0247",
        "buttonCopywriting": "我确认在闪烁",
        "gmtCreate": 1517476347000,
        "productKey": "a1I0TQKlMCW",
        "id": 87,
        "dnCopywriting": "接通电源，确认指示灯闪烁",
        "helpIcon": "http://iotx-ilop.oss-cn-hangzhou.aliyuncs.com/iotx-ilop-portal/p/a124FzVD7BCP4Qfi/networkConfig/1517476333895/timg (1).jpg",
        "rbacTenantId": "755ED7C7810B4255BA026BBC48BF0247"
    }],
    "id": "e6d8bd5e-b79b-475c-b3b8-b3f9c65cdd2b"
}

/awss/time/window/user/bind

path 版本 描述 是否需要用户身份的鉴权
/awss/time/window/user/bind 1.0.3 根据时间窗口（600秒）校验并绑定设备 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
productKey String 是 待配网设备productKey
deviceName String 是 待配网设备deviceName

返回参数

参数 类型 必有 描述
data String 是 已配网设备iotId

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.3",
        "iotToken": "token"
    },
    "params": {
        "productKey": "xxx",
        "deviceName": "xxx"
    }
}

正常返回示例

{
    "id":"xxx",
    "code":200,
    "message":"success",
    "data":"xxxxxxxxxxxxx"
}

/awss/token/user/bind

path 版本 描述 是否需要用户身份的鉴权
/awss/token/user/bind 1.0.3 根据token校验并绑定设备 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
productKey String 是 待配网设备productKey
deviceName String 是 待配网设备deviceName
token String 是 设备上报的token

返回参数

参数 类型 必有 描述
data String 是 已配网设备iotId

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.3",
        "iotToken": "token"
    },
    "params": {
        "productKey": "xxx",
        "deviceName": "xxx",
        "token":"xxx"
    }
}

正常返回示例

{
    "id":"xxx",
    "code":200,
    "message":"success",
    "data":"xxxxxxxxxxxxx"
}

results matching ""

    No results matching ""