PID 权限包

更新时间:2024-04-23 06:44:21下载pdf

适用于云项目关联 PID 授权方式,可以通过调用以下接口获取/操作授权方的数据

授权管理

API名称接口地址
获取令牌GET:/v1.0/token
刷新令牌GET:/v1.0/token/{refreshToken}

语音消息服务

API名称接口地址
发送语音通知POST:/v1.0/iot-03/messages/voices/actions/push
添加语音模板POST:/v1.0/iot-03/msg-templates/voices
获取语音模板清单GET:/v1.0/iot-03/msg-templates/voices
语音模板详情查询GET:/v1.0/iot-03/msg-templates/voices/{template_id}

短信服务

API名称接口地址
添加短信模板POST:/v1.0/iot-03/msg-templates/sms
短信模板详情查询GET:/v1.0/iot-03/msg-templates/sms/{template_id}
获取短信模板清单GET:/v1.0/iot-03/msg-templates/sms
发送短信POST:/v1.0/iot-03/messages/sms/actions/push

邮件服务

API名称接口地址
发送邮件POST:/v1.0/iot-03/messages/mails/actions/push
添加邮件模板POST:/v1.0/iot-03/msg-templates/mails
邮件模板详情查询GET:/v1.0/iot-03/msg-templates/mails/{template_id}
获取邮件模板清单GET:/v1.0/iot-03/msg-templates/mails

行业设备管理

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-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
生成蓝牙设备配网的 authkeyPOST:/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名称接口地址
删除空间DELETE:/v2.0/cloud/space/{space_id}
查询空间下资源列表GET:/v2.0/cloud/space/{space_id}/resource
创建空间POST:/v2.0/cloud/space/creation
查询空间GET:/v2.0/cloud/space/{space_id}
查询空间节点列表GET:/v2.0/cloud/space/child
修改空间信息PUT:/v2.0/cloud/space/{space_id}
判断父子关系GET:/v2.0/cloud/space/relation

全屋管理

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
获取设备列表GET:/v1.0/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
获取用户的设备列表GET:/v1.0/users/{uid}/devices

全屋应用管理

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
修改设备名称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/devices/{deviceId}/status
获取设备列表 v2GET:/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
根据设备 ID查询成员信息列表GET:/v1.0/devices/{device_id}/users

设备管理

API名称接口地址
获取设备状态上报日志GET:/v2.0/cloud/thing/{device_id}/report-logs
获取设备升级进度GET:/v2.0/cloud/thing/{device_id}/firmware/{channel}/progress
批量查询设备详情GET:/v2.0/cloud/thing/batch
移除设备DELETE:/v2.0/cloud/thing/{device_id}
获取设备升级信息GET:/v2.0/cloud/thing/{device_id}/firmware
查询单个设备详情GET:/v2.0/cloud/thing/{device_id}
确认开始设备升级POST:/v2.0/cloud/thing/{device_id}/firmware/{channel}
获取设备状态GET:/v2.0/cloud/thing/{device_id}/state
获取设备操作日志GET:/v2.0/cloud/thing/{device_id}/logs
修改设备基础属性POST:/v2.0/cloud/thing/{device_id}/attribute
冻结/解冻设备POST:/v2.0/cloud/thing/{device_id}/freeze
转移设备POST:/v2.0/cloud/thing/{device_id}/transfer
恢复出厂设置POST:/v2.0/cloud/thing/{device_id}/reset
查询空间下设备列表GET:/v2.0/cloud/thing/space/device
查询项目下设备列表GET:/v2.0/cloud/thing/device
自联网设备扫码配网POST:/v2.0/cloud/thing/active/qrcode
查询配网结果GET:/v2.0/cloud/thing/active/token/{token}

全屋设备控制

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

设备控制

API名称接口地址
下发动作POST:/v2.0/cloud/thing/{device_id}/shadow/actions
查询属性GET:/v2.0/cloud/thing/{device_id}/shadow/properties
修改属性POST:/v2.0/cloud/thing/{device_id}/shadow/properties
查询期望属性GET:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
下发属性POST:/v2.0/cloud/thing/{device_id}/shadow/properties/issue
设置期望属性POST:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
查询物模型GET:/v2.0/cloud/thing/{device_id}/model

设备群组

API名称接口地址
查询群组GET:/v2.0/cloud/thing/group/{group_id}
添加设备PUT:/v2.0/cloud/thing/group/{group_id}/devices
删除设备DELETE:/v2.0/cloud/thing/group/{group_id}/devices
获取设备所在群组GET:/v2.0/cloud/thing/group/device/{device_id}
查询群组属性GET:/v2.0/cloud/thing/group/{group_id}/properties
删除群组DELETE:/v2.0/cloud/thing/group/{group_id}
创建群组POST:/v2.0/cloud/thing/group
下发群组属性POST:/v2.0/cloud/thing/group/properties
查询群组设备GET:/v2.0/cloud/thing/group/{group_id}/devices
修改群组名称PUT:/v2.0/cloud/thing/group/{group_id}/{name}
获取空间下群组GET:/v2.0/cloud/thing/group

设备OTA固件升级

API名称接口地址
确认设备升级POST:/v1.0/iot-03/devices/{device_id}/confirm-upgrade
获取设备上的固件是否有可用升级GET:/v1.0/iot-03/devices/{device_id}/upgrade-infos

场景联动规则

API名称接口地址
获取联动规则详情GET:/v2.0/cloud/scene/rule/{rule_id}
查询联动规则列表GET:/v2.0/cloud/scene/rule
删除联动规则DELETE:/v2.0/cloud/scene/rule
触发一键执行POST:/v2.0/cloud/scene/rule/{rule_id}/actions/trigger
修改联动规则PUT:/v2.0/cloud/scene/rule/{rule_id}
启用/禁用自动化PUT:/v2.0/cloud/scene/rule/state
新增联动规则POST:/v2.0/cloud/scene/rule

智能门锁功能设置

API名称接口地址
分配门锁密码给设备成员POST:/v1.0/devices/{device_id}/device-lock/users/{user_id}/allocate
获取动态密码GET:/v1.0/devices/{device_id}/door-lock/dynamic-password
同步密码POST:/v1.0/devices/{device_id}/door-lock/issue-password
远程含密开门POST:/v1.0/devices/{device_id}/door-lock/open-door
获取开门记录GET:/v1.0/devices/{device_id}/door-lock/open-logs
创建临时密码POST:/v1.0/devices/{device_id}/door-lock/temp-password
获取临时密码信息GET:/v1.0/devices/{device_id}/door-lock/temp-password/{password_id}
获取临时密码列表GET:/v1.0/devices/{device_id}/door-lock/temp-passwords
删除临时密码DELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}
冻结临时密码PUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/freeze-password
修改临时密码PUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/modify-password
删除临时密码记录DELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/record
创建无名称的临时密码POST:/v2.0/devices/{device_id}/door-lock/temp-password
获取临时密钥POST:/v1.0/devices/{device_id}/door-lock/password-ticket
获取成员已绑定的解锁方式GET:/v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/assigned-keys
获取成员未绑定的解锁方式GET:/v1.0/devices/{device_id}/door-lock/unassigned-keys
录入门锁解锁方式PUT:/v1.0/devices/{device_id}/door-lock/actions/entry
删除指定解锁方式DELETE:/v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/unlock-types/{unlock_type}/keys/{unlock_no}
取消指定解锁方式的录入PUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/actions/cancel
设置解锁方式为劫持PUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/keys/{unlock_no}/hijack
获取门锁告警记录GET:/v1.0/devices/{device_id}/door-lock/alarm-logs
设置高级密码POST:/v1.0/devices/{device_id}/door-lock/advanced-password
查看高级密码GET:/v1.0/devices/{device_id}/door-lock/advanced-password
清空临时密码POST:/v1.0/devices/{device_id}/door-lock/temp-passwords/rest-password
获取最近一次的远程开门或告警封面图GET:/v1.0/devices/{device_id}/door-lock/latest/media/url
生成离线临时密码POST:/v1.1/devices/{device_id}/door-lock/offline-temp-password
同步解锁方式POST:/v1.0/smart-lock/devices/{device_id}/opmodes/actions/sync
获取常保活门锁的周期性临时密码列表GET:/v1.0/smart-lock/devices/{device_id}/stand-by-lock-temp-passwords
解除劫持告警DELETE:/v1.0/smart-lock/devices/{device_id}/unlock-types/{unlock_type}/keys/{unlock_sn}/hijack
远程免密开关门POST:/v1.0/smart-lock/devices/{device_id}/password-free/door-operate
获取设备相册列表GET:/v1.0/smart-lock/devices/{device_id}/albums-media
获取临时秘钥POST:/v1.0/smart-lock/devices/{device_id}/password-ticket
将未分配的解锁方式分配给用户POST:/v1.0/devices/{device_id}/door-lock/opmodes/actions/allocate
将历史记录关联给某个用户POST:/v1.0/devices/{device_id}/door-lock/records/{record_id}/actions/allocate
更新解锁方式PUT:/v1.0/devices/{device_id}/door-lock/opmodes/{unlock_sn}
更新离线密码的名称PUT:/v1.0/devices/{device_id}/door-lock/offline-temp-password/{password_id}
获取开门记录/告警记录GET:/v1.0/devices/{device_id}/door-lock/records
查询当前设备已经观看视频次数GET:/v1.0/smart-lock/devices/{device_id}/media-view-times
当前设备已生成的视频文件观看次数加 1POST:/v1.0/smart-lock/devices/{device_id}/media-view-times
解锁方式设置特殊属性POST:/v1.0/smart-lock/devices/{device_id}/opmodes/{opmode_id}/attribute/{attribute}/opmode-attr
获取门锁的临时密码列表GET:/v1.0/devices/{device_id}/door-lock/template/temp-password
创建临时密码POST:/v1.0/smart-lock/device/{device_id}/template/temp-password
删除临时密码DELETE:/v1.0/devices/{device_id}/door-lock/template/temp-password/{password_id}
临时密码详情接口GET:/v1.0/devices/{device_id}/door-lock/template/temp-password/{password_id}

专有设备成员管理

API名称接口地址
新增设备成员POST:/v1.0/devices/{device_id}/user
根据设备 ID查询成员信息列表GET:/v1.0/devices/{device_id}/users
修改设备成员PUT:/v1.0/devices/{device_id}/users/{user_id}
删除用户DELETE:/v1.0/devices/{device_id}/users/{user_id}
查询设备成员信息GET:/v1.0/devices/{device_id}/users/{user_id}
获取用户信息GET:/v1.0/smart-lock/devices/{device_id}/users
更新用户时效PUT:/v1.0/smart-lock/devices/{device_id}/users/{user_id}/schedule
控制门锁设备删除用户POST:/v1.0/smart-lock/devices/{device_id}/users/{user_ids}/actions/delete-users-issue
获取成员的解锁方式列表GET:/v1.0/smart-lock/devices/{device_id}/opmodes/{user_id}
将已分配的解锁方式解绑POST:/v1.0/smart-lock/devices/{device_id}/opmodes/actions/cancel-allocate

设备控制(标准指令集)

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
获取单个设备的状态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名称接口地址
删除人员DELETE:/v1.0/access-control/{device_id}/persons/{person_id}
新增人员POST:/v1.0/access-control/{device_id}/persons/{person_id}
更新人员PUT:/v1.0/access-control/{device_id}/persons/{person_id}

门禁人脸管理

API名称接口地址
新增人脸POST:/v1.0/access-control/{device_id}/persons/{person_id}/faces/{face_id}
删除人脸DELETE:/v1.0/access-control/{device_id}/persons/{person_id}/faces/{face_id}
更新人脸PUT:/v1.0/access-control/{device_id}/persons/{person_id}/faces/{face_id}

门禁二维码管理

API名称接口地址
删除二维码DELETE:/v1.0/access-control/{device_id}/persons/{person_id}/qrcodes/{qr_code}
新增二维码POST:/v1.0/access-control/{device_id}/persons/{person_id}/qrcodes/{qr_code}
更新二维码PUT:/v1.0/access-control/{device_id}/persons/{person_id}/qrcodes/{qr_code}

门禁卡管理

API名称接口地址
冻结门禁卡PUT:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}/freeze
删除门禁卡DELETE:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}
解冻门禁卡PUT:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}/unfreeze
新增门禁卡POST:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}
更新门禁卡PUT:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}

门禁通行密码管理

API名称接口地址
删除门禁通行密码DELETE:/v1.0/access-control/{device_id}/persons/{person_id}/passpwd/{pass_pwd}
更新门禁通行密码PUT:/v1.0/access-control/{device_id}/persons/{person_id}/passpwd/{pass_pwd}
新增门禁通行密码POST:/v1.0/access-control/{device_id}/persons/{person_id}/passpwd/{pass_pwd}

门禁远程开门

API名称接口地址
开门指令发送POST:/v1.0/access-control/{device_id}/persons/{person_id}/actions/open

公区设备信息

API名称接口地址
获取设备详情GET:/v1.0/expand/devices/{device_id}
获取设备列表GET:/v1.0/expand/devices

公区设备指令

API名称接口地址
指令记录查询GET:/v1.0/expand/cmds/{sn}

呼叫住户

API名称接口地址
呼叫门禁人员POST:/v1.0/access-control/{device_id}/persons/actions/call

公区设备权限

API名称接口地址
删除用户的设备权限DELETE:/v1.0/expand/spaces/{device_id}/persons/{person_id}
新增用户设备权限POST:/v1.0/expand/spaces/{device_id}/persons/{person_id}

门禁用户批量操作

API名称接口地址
批量新增人员POST:/v1.0/access-control/{device_id}/persons
批量新增二维码POST:/v1.0/access-control/{device_id}/persons/qrcodes
批量删除人员DELETE:/v1.0/access-control/{device_id}/persons
批量删除人脸DELETE:/v1.0/access-control/{device_id}/persons/faces
批量新增人脸POST:/v1.0/access-control/{device_id}/persons/faces
批量删除二维码DELETE:/v1.0/access-control/{device_id}/persons/qrcodes

设备能力管理

API名称接口地址
查询设备能力列表GET:/v1.0/iot-03/devices/{device_id}/capabilities-definition

公区设备功能点

API名称接口地址
获取设备功能池GET:/v1.0/expand/devices/{device_id}/function-pool
修改设备功能点PUT:/v1.0/expand/devices/{device_id}/functions
获取设备功能点列表GET:/v1.0/expand/devices/{device_id}/functions

卡片操作

API名称接口地址
写卡POST:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors
修改卡名称PUT:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors
获取支持离线密码功能的门锁列表GET:/v1.0/devices/{device_id}/offline-pwd-locks
删卡DELETE:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors
读取卡片在云端保存的信息GET:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors
获取写卡记录GET:/v1.0/devices/{device_id}/door-lock/card-issuers/cards

智能水表开关管理

API名称接口地址
设置阀门开启度POST:/v1.0/water-meter/{device_id}/actions/valve-open-degree

用电管理

API名称接口地址
查询用电设备的剩余电量GET:/v1.0/iot-03/power-devices/{device_id}/balance-charge
设置用电设备的预付费功能启用状态POST:/v1.0/iot-03/power-devices/{device_id}/prepayment
设置用电设备的余额告警阈值POST:/v1.0/iot-03/power-devices/{device_id}/balance-threshold
查询用电设备预付费功能启用状态GET:/v1.0/iot-03/power-devices/{device_id}/prepayment
查询用电设备的余额告警阈值GET:/v1.0/iot-03/power-devices/{device_id}/balance-threshold
清零用电设备的剩余电量POST:/v1.0/iot-03/power-devices/{device_id}/clear-charge
查询用电设备的电量充值记录GET:/v1.0/iot-03/power-devices/{device_id}/charge-records
用电设备电量充值POST:/v1.0/iot-03/power-devices/{device_id}/charge

历史轨迹

API名称接口地址
获取设备轨迹点GET:/v2.0/iot-01/tracks/detail
获取设备轨迹分段GET:/v2.0/iot-01/tracks/segments

告警管理

API名称接口地址
查询围栏告警GET:/v2.0/iot-01/fences/warn/list

用电统计

API名称接口地址
查询指定维度节点能源数据时间趋势GET:/v1.0/iot-03/energy/{energy_type}/statistics
监测点能耗排行GET:/v1.0/iot-03/energy/{energy_type}/monitors-top
查询空间能源设备列表GET:/v1.0/iot-03/energy/{energy_type}/space/devices
查询监测点能源数据趋势GET:/v1.0/iot-03/energy/{energy_type}/monitors-trend
查询空间下能耗排行GET:/v1.0/iot-03/energy/{energy_type}/space/statistics-top
查询空间能耗趋势GET:/v1.0/iot-03/energy/{energy_type}/space/statistics-trend
查询空间下的设备用电趋势GET:/v1.0/iot-03/energy/{energy_type}/devices/statistics-trend
查询空间下的能耗总量GET:/v1.0/iot-03/energy/{energy_type}/space/statistics-sum
项目空间统计GET:/v1.0/iot-03/energy/{energy_type}/space-count
查询空间下的设备用电排行GET:/v1.0/iot-03/energy/{energy_type}/space/statistics/devices-top
批量移除用电设备POST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices-remove
批量添加能源设备POST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices
查询节点总用电量GET:/v1.0/iot-03/energy/{energy_type}/space/nodes/statistics-sum
多设备用电趋势汇总统计GET:/v1.0/iot-03/energy/{energy_type}/devices/nodes/statistics-trend
查询设备的总用电量GET:/v1.0/iot-03/energy/{energy_type}/device/nodes/statistics-sum

免App接入

API名称接口地址
设备控制POST:/v1.0/iot-01/voice/users/devices/{device_id}/commands
发现设备GET:/v1.0/iot-01/voice/users/devices
场景发现GET:/v1.0/iot-01/voice/users/scenes
设备状态查询GET:/v1.0/iot-01/voice/users/devices/{device_id}/status
控制场景POST:/v1.0/iot-01/voice/users/scenes/{scene_id}/commands

断路器数据管理

API名称接口地址
获取实时数据GET:/v1.0/electric-energy/{device_id}/actions/realtime-data

城市查询

API名称接口地址
查询城市列表GET:/v1.0/iot-03/cities
根据城市 ID 查询城市信息GET:/v1.0/iot-03/cities/{city_id}
根据经纬度查询城市信息GET:/v1.0/iot-03/cities/positions

设备定时

API名称接口地址
启用/禁用设备定时PUT:/v2.0/cloud/timer/device/{device_id}/state
查询设备定时GET:/v2.0/cloud/timer/device/{device_id}
新增设备定时POST:/v2.0/cloud/timer/device/{device_id}
修改设备定时PUT:/v2.0/cloud/timer/device/{device_id}
批量删除设备定时DELETE:/v2.0/cloud/timer/device/{device_id}/batch
清空设备定时DELETE:/v2.0/cloud/timer/device/{device_id}

设备能力访问

API名称接口地址
执行设备指定能力POST:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code}
查询设备指定能力GET:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code}
批量执行设备能力POST:/v1.0/iot-03/devices/{device_id}/capabilities
查询设备能力状态GET:/v1.0/iot-03/devices/{device_id}/capabilities

网关管理

API名称接口地址
查看网关是否支持故障转移GET:/v1.0/alps/transfer/is/support
触发故障网关转移POST:/v1.0/alps/transfer/trigger
获取当前故障转移状态GET:/v1.0/alps/{gw_id}/transfer/status

告警统计

API名称接口地址
查询告警统计图表GET:/v1.0/si/iot-03/alarm-statistics/chart
查询告警统计GET:/v1.0/si/iot-03/alarm-statistics

天气

API名称接口地址
获取当前天气GET:/v2.0/iot-03/weather/current
获取 7 日天气预报GET:/v2.0/iot-03/weather/forecast/daily
获取历史 24 小时天气GET:/v2.0/iot-03/weather/history24

设备云云接入

API名称接口地址
注册设备POST:/v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}/register
设备属性上报POST:/v1.0/iot-03/3rdcloud/devices/{device_id}/property/report
设备动作响应上报POST:/v1.0/iot-03/3rdcloud/devices/{device_id}/action-resp/report
获取设备信息GET:/v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}
更新设备PUT:/v1.0/iot-03/3rdcloud/devices/{device_id}
设备上线PUT:/v1.0/iot-03/3rdcloud/devices/{device_id}/online
删除设备DELETE:/v1.0/iot-03/3rdcloud/devices/{device_id}/remove
设备下线PUT:/v1.0/iot-03/3rdcloud/devices/{device_id}/offline
设备事件上报POST:/v1.0/iot-03/3rdcloud/devices/{device_id}/event/report
解绑设备POST:/v1.0/cloud/thing/devices/{device_id}/unbind
设备功能点上报POST:/v1.0/cloud/thing/devices/{device_id}/datapoint/report
注册子设备POST:/v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}/sub/register

自定义纬度统计

API名称接口地址
删除自定义维度节点DELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}
从自定义维度节点移除设备DELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices
删除监测点DELETE:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}
查询自定义维度节点设备GET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices
查询自定义维度节点GET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes
查询监测点绑定设备GET:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices
查询监测点GET:/v1.0/iot-03/statistical-indicators/monitors
统计监测点GET:/v1.0/iot-03/statistical-indicators/monitors/devices-count
添加设备到自定义维度节点POST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices
创建自定义维度节点POST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes
创建自定义维度POST:/v1.0/iot-03/statistical-dimensions/{dimension_code}
修改自定义维度节点PUT:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}
移除监测点的设备POST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices-remove
监测点绑定设备POST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices
新增监测点POST:/v1.0/iot-03/statistical-indicators/monitors
修改监测点名称PUT:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}

自有App接入

API名称接口地址
场景发现GET:/v1.0/iot-01/voice/users/{uid}/scenes
设备状态查询GET:/v1.0/iot-01/voice/users/{uid}/devices/{device_id}/status
场景控制POST:/v1.0/iot-01/voice/users/{uid}/scenes/{scene_id}/commands
设备发现GET:/v1.0/iot-01/voice/users/{uid}/devices
设备控制POST:/v1.0/iot-01/voice/users/{uid}/devices/{device_id}/commands

固件管理

API名称接口地址
根据固件 key 查询固件版本信息GET:/v1.0/iot-03/product/firmware/versions
根据固件 key 批量查询固件详情GET:/v1.0/iot-03/product/firmwares
根据产品 ID 查询产品下的硬件信息GET:/v1.0/iot-03/product/hardwares

门禁设备管理

API名称接口地址
清理设备数据POST:/v1.0/access-control/{device_id}/actions/cleardata
云端同步设备端时间POST:/v1.0/access-control/{device_id}/actions/synctime

文本转语音设备播报

API名称接口地址
设备 TTS 下发POST:/v1.0/aispeech/voice/push

激光型扫地机器人

API名称接口地址
修改清扫地图名称POST:/v1.0/users/sweepers/file/{device_id}/file-name
获取实时地图文件链接信息GET:/v1.0/users/sweepers/file/{device_id}/realtime-map
删除清扫地图文件DELETE:/v1.0/users/sweepers/file/{device_id}/clean-history
获取地图文件列表GET:/v1.0/users/sweepers/file/{device_id}/list
获取地图文件下载链接GET:/v1.0/users/sweepers/file/{device_id}/download

断路器告警阈值管理

API名称接口地址
设置过压保护值POST:/v1.0/electric-energy/{device_id}/actions/voltage-over
设置限定功率POST:/v1.0/electric-energy/{device_id}/actions/power-limit
设置限定电流POST:/v1.0/electric-energy/{device_id}/actions/current-limit
设置漏电预警值POST:/v1.0/electric-energy/{device_id}/actions/leak-warn-value
设置漏电动作值POST:/v1.0/electric-energy/{device_id}/actions/leak-action-value
设置电量预警值POST:/v1.0/electric-energy/{device_id}/actions/electric-warn
设置欠压保护值POST:/v1.0/electric-energy/{device_id}/actions/voltage-under
设置过温保护值POST:/v1.0/electric-energy/{device_id}/actions/temp-over

用电安全

API名称接口地址
查询用电设备用电安全规则GET:/v1.0/iot-03/power-devices/{device_id}/safety-rules
设置用电设备的用电安全规则POST:/v1.0/iot-03/power-devices/{device_id}/safety-rules
查询用电设备支持的用电安全规则GET:/v1.0/iot-03/power-devices/{device_id}/support-safety-rules

家居控制

API名称接口地址
获取家庭列表GET:/v1.0/iot-01/voice/home/list
控制家居POST:/v1.0/iot-01/voice/homes/{home_id}/dm

地理位置服务

API名称接口地址
逆向地址解析GET:/v1.0/iot-03/geocode-cities/latitude-longitude
正向地址解析GET:/v1.0/iot-03/geocode-cities/address
获取 IP 定位 V1.1GET:/v1.1/iot-03/locations/ip

校园办公资产管理

API名称接口地址
转移设备POST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer

实时位置

API名称接口地址
批量查询设备实时位置GET:/v2.0/iot-01/tracks/location

国家码查询

API名称接口地址
获取国家码列表GET:/v3.0/iot-03/all-countries

电子地理围栏

API名称接口地址
添加围栏监控对象POST:/v2.0/iot-01/fences/{fence_id}/entity
创建多边形围栏POST:/v2.0/iot-01/fences/polygon
修改多边形围栏PUT:/v2.0/iot-01/fences/polygon/{fence_id}
查询围栏监控对象GET:/v2.0/iot-01/fences/{fence_id}/entity
查询所有围栏GET:/v2.0/iot-01/fences/list
创建圆形围栏POST:/v2.0/iot-01/fences/circle
开启关闭围栏PUT:/v2.0/iot-01/fences/{fence_id}/open
批量查询私有围栏GET:/v2.0/iot-01/fences/private/batch
批量保存圆形私有围栏POST:/v2.0/iot-01/fences/circle/private/batch
修改圆形围栏PUT:/v2.0/iot-01/fences/circle/{fence_id}
根据围栏 ID 查询围栏GET:/v2.0/iot-01/fences/batch
批量保存多边形私有围栏POST:/v2.0/iot-01/fences/polygon/private/batch

断路器开关管理

API名称接口地址
设置使能开关POST:/v1.0/electric-energy/{device_id}/actions/hand-enable
设置线路开关POST:/v1.0/electric-energy/{device_id}/actions/switch

产品管理

API名称接口地址
搜索我的产品列表GET:/v1.0/products/own/list

设备组管理

API名称接口地址
获取群组设备任务详情GET:/v1.0/iot-03/device-groups/{group_id}/tasks

日志管理

API名称接口地址
保存操作日志POST:/v1.0/iot-03/audit/operate-logs
日志操作列表GET:/v1.0/iot-03/audit/operate-logs