联系我们

注册

登录

联系我们

注册

登录

取消

云服务 API 参考IoT Core 服务

IoT Core 服务

更新时间：2023-01-19 07:06:42下载pdf

提供了 IoT 行业最核心的设备连接和管理能力，通过多种方法实现设备接入涂鸦 IoT 开发平台，在 IoT 应用和设备间建立安全，稳定的通信并实现设备管理、监测和控制等操作。

通用设备控制

API 名称	接口地址
获取设备规格属性	GET:/v1.0/iot-03/devices/{device_id}/specification
获取设备支持的指令集	GET:/v1.0/iot-03/devices/{device_id}/functions
获取品类支持的指令集	GET:/v1.0/iot-03/categories/{category}/functions
下发指令	POST:/v1.0/iot-03/devices/{device_id}/commands
获取产品品类列表	GET:/v1.0/iot-03/device-categories

通用设备管理

API 名称	接口地址
查询设备是否冻结	GET:/v1.0/iot-03/devices/{device_id}/freeze-state
批量移除设备	DELETE:/v1.0/iot-03/devices
修改设备信息	PUT:/v1.0/iot-03/devices/{device_id}
移除设备	DELETE:/v1.0/iot-03/devices/{device_id}
恢复出厂设置	POST:/v1.0/iot-03/devices/{device_id}/actions/reset
获取子设备列表	GET:/v1.0/iot-03/devices/{device_id}/sub-devices
修改设备冻结状态	PUT:/v1.0/iot-03/devices/{device_id}/freeze-state
获取设备信息	GET:/v1.1/iot-03/devices/{device_id}
获取设备规格属性	GET:/v1.2/iot-03/devices/{device_id}/specification
批量获取设备扩展属性	GET:/v1.0/iot-03/devices/properties
获取设备扩展属性	GET:/v1.0/iot-03/devices/{device_id}/properties
批量查询设备协议	GET:/v1.0/iot-03/devices/protocol
获取设备列表	GET:/v1.3/iot-03/devices

通用设备状态查询

API 名称	接口地址
获取单个设备的状态	GET:/v1.0/iot-03/devices/{device_id}/status
批量获取设备最新状态	GET:/v1.0/iot-03/devices/status
获取状态集	GET:/v1.0/iot-03/categories/{category}/status

行业资产管理

API 名称	接口地址
批量查询资产信息	GET:/v1.0/iot-02/assets
删除资产	DELETE:/v1.0/iot-02/assets/{asset_id}
修改资产	PUT:/v1.0/iot-02/assets/{asset_id}
节点下设备分页查询	GET:/v1.0/iot-02/assets/{asset_id}/devices
当前节点下子节点分页查询	GET:/v1.0/iot-02/assets/{asset_id}/sub-assets
根据id查询资产	GET:/v1.0/iot-02/assets/{asset_id}
新增资产	POST:/v1.0/iot-02/assets
授权资产	POST:/v1.0/iot-03/assets/actions/user-authorized
查询被授权的资产	GET:/v1.0/iot-03/users/{uid}/assets
批量资产授权用户（支持选择是否授权子节点）	POST:/v1.0/iot-03/users/{uid}/actions/batch-assets-authorized
取消用户资产的权限（支持选择是否取消子节点数据）	POST:/v1.0/iot-03/users/{uid}/actions/assets-unauthorized
批量取消用户的资产权限	POST:/v1.0/iot-03/users/{uid}/actions/batch-assets-unauthorized
分页查询跨层级子资产	POST:/v1.1/iot-02/cross-level-sub-assets
查询授权用户列表	GET:/v1.0/iot-03/{asset_id}/authorized_users
转移设备	POST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer
分页查询资产子节点（支持排序）	GET:/v1.1/iot-02/assets/{asset_id}/sub-assets

行业用户管理

API 名称	接口地址
根据用户 ID 查询用户	GET:/v1.0/iot-02/users/{user_id}
注册用户	POST:/v1.0/iot-02/users
删除用户	DELETE:/v1.0/iot-02/users/{user_id}
重置密码	PUT:/v1.0/iot-02/users/reset-password
分页查询用户	GET:/v1.1/iot-02/users
修改用户基本信息	PUT:/v1.1/iot-02/users/{user_id}
根据用户名查询用户	GET:/v1.2/iot-02/users/{user_name}
分页查询用户	GET:/v1.1/iot-02/users/page

行业设备注册

API名称	接口地址
蓝牙单设备注册	POST:/v1.0/iot-03/device-registration/single-bluetooth/actions/register
搜寻子设备	POST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/discover
生成蓝牙设备配网的 authkey	POST:/v1.0/iot-03/device-registration/single-bluetooth/auth-key
蓝牙单品设备激活	POST:/v1.0/iot-03/device-registration/single-bluetooth/actions/active
生成配网令牌	POST:/v1.0/iot-03/device-registration/token
停止发现子设备	POST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/stop-discover
获取网关新入网的子设备列表	GET:/v1.0/iot-03/device-registration/devices/{device_id}/sub-devices
根据配网令牌查询设备激活结果	GET:/v1.1/iot-03/device-registration/tokens/{token}
获取云端系统时间	GET:/v1.0/iot-03/cloud/system-time
NB 设备扫码配网	POST:/v1.0/iot-03/device-registration/qrcode-bind
获取资产下的网关列表	GET:/v1.0/iot-03/device-registration/assets/{asset_id}/gateways
生成蓝牙配网 RSA 公钥	POST:/v1.0/iot-03/device-registration/assets/{asset_id}/encryptions/rsa/public-key
资产绑定设备	POST:/v1.1/iot-02/device-bc-bind

全屋管理

API 名称	接口地址
添加家庭	POST:/v1.0/home/create-home
查询家庭	GET:/v1.0/homes/{home_id}
修改家庭	PUT:/v1.0/homes/{home_id}
删除家庭	DELETE:/v1.0/homes/{home_id}
查询家庭下的设备列表	GET:/v1.0/homes/{home_id}/devices
查询家庭成员列表信息	GET:/v1.0/homes/{home_id}/members
添加家庭成员	POST:/v1.0/homes/{home_id}/members
修改家庭成员信息	PUT:/v1.0/homes/{home_id}/members/{uid}
删除家庭成员	DELETE:/v1.0/homes/{home_id}/members/{uid}
添加房间	POST:/v1.0/homes/{home_id}/room
查询家庭下的房间列表	GET:/v1.0/homes/{home_id}/rooms
删除房间	DELETE:/v1.0/homes/{home_id}/rooms/{room_id}
修改房间名称	PUT:/v1.0/homes/{home_id}/rooms/{room_id}
查询家庭房间设备	GET:/v1.0/homes/{home_id}/rooms/{room_id}/devices
查询⽤户家庭列表	GET:/v1.0/users/{uid}/homes
新增房间内的设备	POST:/v1.0/homes/{home_id}/rooms/{room_id}/devices
修改家庭下房间内的设备	PUT:/v1.0/homes/{home_id}/rooms/{room_id}/devices
删除家庭下房间内的设备	DELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices

用户管理

API 名称	接口地址
同步用户	POST:/v1.0/apps/{schema}/user
获取用户信息	GET:/v1.0/users/{uid}/infos
获取用户列表	GET:/v2.0/apps/{schema}/users
取消删除	POST:/v1.0/users/{uid}/actions/cancel-delete
用户预删除	POST:/v1.0/users/{uid}/actions/pre-delete

应用管理

API 名称	接口地址
获取应用详情	GET:/v1.0/apps/{schema}
获取应用的名称、logo、描述、创建时间等	GET:/v1.1/apps/{schema}

配网管理

API 名称	接口地址
获取子设备列表	GET:/v1.0/devices/{deviceId}/list-sub
允许子设备入网	PUT:/v1.0/devices/{deviceId}/enabled-sub-discovery
获取配网设备列表	GET:/v1.0/device/paring/tokens/{token}

设备管理

API 名称	接口地址
查询网关下 Zigbee 设备	GET:/v1.0/devices/{deviceId}/sub-devices
批量查询设备出厂信息	GET:/v1.0/devices/factory-infos
获取设备列表	GET:/v1.0/devices
修改设备名称	PUT:/v1.0/devices/{device_id}
查询设备日志	GET:/v1.0/devices/{device_id}/logs
恢复设备出厂设置	PUT:/v1.0/devices/{device_id}/reset-factory
获取设备详情	GET:/v1.0/devices/{deviceId}
移除设备	DELETE:/v1.0/devices/{deviceId}
获取用户的设备列表	GET:/v1.0/users/{uid}/devices
获取设备状态	GET:/v1.0/devices/{deviceId}/status
获取设备列表 v2	GET:/v2.0/devices
批量查询关联 App 用户维度设备列表	GET:/v1.0/iot-01/associated-users/devices
删除用户	DELETE:/v1.0/devices/{device_id}/users/{user_id}
修改设备成员	PUT:/v1.0/devices/{device_id}/users/{user_id}
查询设备成员信息	GET:/v1.0/devices/{device_id}/users/{user_id}
新增设备成员	POST:/v1.0/devices/{device_id}/user

设备控制

API 名称	接口地址
修改功能点名称	PUT:/v1.0/devices/{device_id}/functions/{function_code}
控制设备	POST:/v1.0/devices/{deviceId}/commands
获取设备支持的指令集	GET:/v1.0/devices/{deviceId}/functions
获取设备规格属性	GET:/v1.0/devices/{deviceId}/specifications
按品类获取指令集	GET:/v1.0/functions/{category}
批量获取设备支持的指令集	GET:/v1.0/devices/functions
获取设备规格属性	GET:/v1.1/devices/{device_id}/specifications

下一篇通用设备能力