PID Permission Package

Last Updated on : 2024-04-23 06:44:02download

For authorization methods related to PID, you can retrieve/manipulate the data of the authorizer by invoking the following interface.

Authorization management

API NameURL
Get a TokenGET:/v1.0/token
Refresh TokenGET:/v1.0/token/{refreshToken}

Voice Message Service

API NameURL
Send Voice NotificationPOST:/v1.0/iot-03/messages/voices/actions/push
Add a voice templatePOST:/v1.0/iot-03/msg-templates/voices
Get the list of voice templatesGET:/v1.0/iot-03/msg-templates/voices
Query the details of the voice templateGET:/v1.0/iot-03/msg-templates/voices/{template_id}

Message Service

API NameURL
Add SMS TemplatePOST:/v1.0/iot-03/msg-templates/sms
Query the details of the SMS templateGET:/v1.0/iot-03/msg-templates/sms/{template_id}
Get the list of SMS templatesGET:/v1.0/iot-03/msg-templates/sms
Send SMS messagesPOST:/v1.0/iot-03/messages/sms/actions/push

Email

API NameURL
Send EmailPOST:/v1.0/iot-03/messages/mails/actions/push
Add Email TemplatePOST:/v1.0/iot-03/msg-templates/mails
Query the details of the email templateGET:/v1.0/iot-03/msg-templates/mails/{template_id}
Get the list of email templatesGET:/v1.0/iot-03/msg-templates/mails

Industry Devices management

API NameURL
Check whether a device is frozenGET:/v1.0/iot-03/devices/{device_id}/freeze-state
Delete devices in batchesDELETE:/v1.0/iot-03/devices
Modify the device informationPUT:/v1.0/iot-03/devices/{device_id}
Delete a deviceDELETE:/v1.0/iot-03/devices/{device_id}
Restore defaultsPOST:/v1.0/iot-03/devices/{device_id}/actions/reset
Get the list of sub-devicesGET:/v1.0/iot-03/devices/{device_id}/sub-devices
Modify the frozen status of a devicePUT:/v1.0/iot-03/devices/{device_id}/freeze-state
Get Device InformationGET:/v1.1/iot-03/devices/{device_id}
Get Device SpecificationGET:/v1.2/iot-03/devices/{device_id}/specification
Get Extended Properties in BulkGET:/v1.0/iot-03/devices/properties
Get Extended PropertiesGET:/v1.0/iot-03/devices/{device_id}/properties
Query Protocols of Multiple DevicesGET:/v1.0/iot-03/devices/protocol
Get Device ListGET:/v1.3/iot-03/devices

Industry Asset Management

API NameURL
Query assets based on idGET:/v1.0/iot-02/assets
Delete AssetDELETE:/v1.0/iot-02/assets/{asset_id}
Modify AssetPUT:/v1.0/iot-02/assets/{asset_id}
Query Node Devices in PagesGET:/v1.0/iot-02/assets/{asset_id}/devices
Paging query of sub-nodes under the current nodeGET:/v1.0/iot-02/assets/{asset_id}/sub-assets
Query assets based on idGET:/v1.0/iot-02/assets/{asset_id}
Add new assetPOST:/v1.0/iot-02/assets
Authorize AssetsPOST:/v1.0/iot-03/assets/actions/user-authorized
Query the Authorized AssetsGET:/v1.0/iot-03/users/{uid}/assets
Authorize User with AssetsPOST:/v1.0/iot-03/users/{uid}/actions/batch-assets-authorized
Revoke a User's Asset PermissionsPOST:/v1.0/iot-03/users/{uid}/actions/assets-unauthorized
Revoke Asset Permissions from a UserPOST:/v1.0/iot-03/users/{uid}/actions/batch-assets-unauthorized
Query Cross-Level Sub-AssetsPOST:/v1.1/iot-02/cross-level-sub-assets
Query Authorized User ListGET:/v1.0/iot-03/{asset_id}/authorized_users
Transfer DevicePOST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer
Query and Sort Asset Sub-NodeGET:/v1.1/iot-02/assets/{asset_id}/sub-assets

Industry User Management

API NameURL
Query User Information by User IDGET:/v1.0/iot-02/users/{user_id}
Register UserPOST:/v1.0/iot-02/users
Delete UserDELETE:/v1.0/iot-02/users/{user_id}
Reset PasswordPUT:/v1.0/iot-02/users/reset-password
Query User Information on PagesGET:/v1.1/iot-02/users
Modify User InformationPUT:/v1.1/iot-02/users/{user_id}
Query User by UsernameGET:/v1.2/iot-02/users/{user_name}
Query User Information on PagesGET:/v1.1/iot-02/users/page

Industry Device Registration

API NameURL
Register a Bluetooth DevicePOST:/v1.0/iot-03/device-registration/single-bluetooth/actions/register
Search for sub-devicesPOST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/discover
Generate an authKey for Bluetooth Device PairingPOST:/v1.0/iot-03/device-registration/single-bluetooth/auth-key
Activate a Bluetooth DevicePOST:/v1.0/iot-03/device-registration/single-bluetooth/actions/active
Generate Pairing TokenPOST:/v1.0/iot-03/device-registration/token
Stop Discovering Sub-devicesPOST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/stop-discover
Get the list of newly connected sub-devicesGET:/v1.0/iot-03/device-registration/devices/{device_id}/sub-devices
Query device activation result based on network distribution tokenGET:/v1.1/iot-03/device-registration/tokens/{token}
Get Cloud System TimeGET:/v1.0/iot-03/cloud/system-time
Pair NB-IoT Device by Scanning QR CodePOST:/v1.0/iot-03/device-registration/qrcode-bind
Get the list of gateways under the assetGET:/v1.0/iot-03/device-registration/assets/{asset_id}/gateways
Generate RSA Public Key for Bluetooth PairingPOST:/v1.0/iot-03/device-registration/assets/{asset_id}/encryptions/rsa/public-key
Bind Device with AssetPOST:/v1.1/iot-02/device-bc-bind

Space Management

API NameURL
Delete SpaceDELETE:/v2.0/cloud/space/{space_id}
Query Resources in SpaceGET:/v2.0/cloud/space/{space_id}/resource
Create SpacePOST:/v2.0/cloud/space/creation
Query SpaceGET:/v2.0/cloud/space/{space_id}
Query Space ListGET:/v2.0/cloud/space/child
Modify Space InformationPUT:/v2.0/cloud/space/{space_id}
Query Parent-Child RelationshipGET:/v2.0/cloud/space/relation

Home Management

API NameURL
Add HomePOST:/v1.0/home/create-home
Query HomeGET:/v1.0/homes/{home_id}
Modify HomePUT:/v1.0/homes/{home_id}
Delete FamilyDELETE:/v1.0/homes/{home_id}
Query Devices in HomeGET:/v1.0/homes/{home_id}/devices
Query Home MembersGET:/v1.0/homes/{home_id}/members
Add Home MemberPOST:/v1.0/homes/{home_id}/members
Modify family member informationPUT:/v1.0/homes/{home_id}/members/{uid}
Delete Home MemberDELETE:/v1.0/homes/{home_id}/members/{uid}
Add RoomPOST:/v1.0/homes/{home_id}/room
Query Room ListGET:/v1.0/homes/{home_id}/rooms
Delete RoomDELETE:/v1.0/homes/{home_id}/rooms/{room_id}
Modify the room namePUT:/v1.0/homes/{home_id}/rooms/{room_id}
Query family room equipmentGET:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Query Home ListGET:/v1.0/users/{uid}/homes
Add a device in the roomPOST:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Modify Room DevicesPUT:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Delete Devices from RoomDELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Get Device ListGET:/v1.0/devices

Smart Home User Management

API NameURL
Sync User AccountPOST:/v1.0/apps/{schema}/user
Get User InformationGET:/v1.0/users/{uid}/infos
Get User ListGET:/v2.0/apps/{schema}/users
UndeletePOST:/v1.0/users/{uid}/actions/cancel-delete
Pre-delete the user accountPOST:/v1.0/users/{uid}/actions/pre-delete
Get User's Device ListGET:/v1.0/users/{uid}/devices

Smart Home Application Management

API NameURL
Get App DetailsGET:/v1.0/apps/{schema}
Get App InformationGET:/v1.1/apps/{schema}

Smart Home Network Management

API NameURL
Get a list of sub-devicesGET:/v1.0/devices/{deviceId}/list-sub
Allow sub-devices to access the networkPUT:/v1.0/devices/{deviceId}/enabled-sub-discovery
Get the list of network equipmentGET:/v1.0/device/paring/tokens/{token}

Smart Home Device Management

API NameURL
Query Zigbee devices under the gatewayGET:/v1.0/devices/{deviceId}/sub-devices
Query Factory Information in BulkGET:/v1.0/devices/factory-infos
Modify device namePUT:/v1.0/devices/{device_id}
Query device logGET:/v1.0/devices/{device_id}/logs
Restore device factory settingsPUT:/v1.0/devices/{device_id}/reset-factory
Get Device DetailsGET:/v1.0/devices/{deviceId}
Delete DeviceDELETE:/v1.0/devices/{deviceId}
Get Device StatusGET:/v1.0/devices/{deviceId}/status
Get Device List v2GET:/v2.0/devices
Batch query for the list of associated App user dimension devicesGET:/v1.0/iot-01/associated-users/devices
Delete UserDELETE:/v1.0/devices/{device_id}/users/{user_id}
Modify Device MembersPUT:/v1.0/devices/{device_id}/users/{user_id}
Query Device MembersGET:/v1.0/devices/{device_id}/users/{user_id}
Add Device MemberPOST:/v1.0/devices/{device_id}/user
Query Member List by Device IDGET:/v1.0/devices/{device_id}/users

Device Management

API NameURL
Get Status Reporting LogGET:/v2.0/cloud/thing/{device_id}/report-logs
Get Update ProgressGET:/v2.0/cloud/thing/{device_id}/firmware/{channel}/progress
Query Device Details in BulkGET:/v2.0/cloud/thing/batch
Delete DeviceDELETE:/v2.0/cloud/thing/{device_id}
Get Update InformationGET:/v2.0/cloud/thing/{device_id}/firmware
Query Device DetailsGET:/v2.0/cloud/thing/{device_id}
Confirm Start of UpdatePOST:/v2.0/cloud/thing/{device_id}/firmware/{channel}
Get Device StateGET:/v2.0/cloud/thing/{device_id}/state
Get Operation LogGET:/v2.0/cloud/thing/{device_id}/logs
Modify Basic PropertiesPOST:/v2.0/cloud/thing/{device_id}/attribute
Freeze/Unfreeze DevicePOST:/v2.0/cloud/thing/{device_id}/freeze
Transfer DevicePOST:/v2.0/cloud/thing/{device_id}/transfer
Restore Factory DefaultsPOST:/v2.0/cloud/thing/{device_id}/reset
Query Devices in SpaceGET:/v2.0/cloud/thing/space/device
Query Devices in ProjectGET:/v2.0/cloud/thing/device
Pair Device by Scanning QR CodePOST:/v2.0/cloud/thing/active/qrcode
Query Pairing ResultGET:/v2.0/cloud/thing/active/token/{token}

Smart Home Device Control

API NameURL
Modify function point namePUT:/v1.0/devices/{device_id}/functions/{function_code}
Control DevicePOST:/v1.0/devices/{deviceId}/commands
Get Instruction Set Supported by DeviceGET:/v1.0/devices/{deviceId}/functions
Get Device Specification AttributeGET:/v1.0/devices/{deviceId}/specifications
Get the instructions set by categoryGET:/v1.0/functions/{category}
Get Instruction Sets in BulkGET:/v1.0/devices/functions
Get Device Specification AttributeGET:/v1.1/devices/{device_id}/specifications

Device Control

API NameURL
Send ActionsPOST:/v2.0/cloud/thing/{device_id}/shadow/actions
Query PropertiesGET:/v2.0/cloud/thing/{device_id}/shadow/properties
Modify PropertiesPOST:/v2.0/cloud/thing/{device_id}/shadow/properties
Query Desired PropertiesGET:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
Send PropertyPOST:/v2.0/cloud/thing/{device_id}/shadow/properties/issue
Set Desired PropertyPOST:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
Query Things Data ModelGET:/v2.0/cloud/thing/{device_id}/model

Device Group

API NameURL
Query GroupGET:/v2.0/cloud/thing/group/{group_id}
Add DevicePUT:/v2.0/cloud/thing/group/{group_id}/devices
Delete DevicesDELETE:/v2.0/cloud/thing/group/{group_id}/devices
Get Device GroupGET:/v2.0/cloud/thing/group/device/{device_id}
Query Group PropertiesGET:/v2.0/cloud/thing/group/{group_id}/properties
Delete GroupDELETE:/v2.0/cloud/thing/group/{group_id}
Create GroupPOST:/v2.0/cloud/thing/group
Send Group PropertiesPOST:/v2.0/cloud/thing/group/properties
Query Group DevicesGET:/v2.0/cloud/thing/group/{group_id}/devices
Rename GroupPUT:/v2.0/cloud/thing/group/{group_id}/{name}
Get Groups in SpaceGET:/v2.0/cloud/thing/group

Devices OTA

API NameURL
Confirm device upgradePOST:/v1.0/iot-03/devices/{device_id}/confirm-upgrade
Obtain whether the firmware on the device is available for upgradeGET:/v1.0/iot-03/devices/{device_id}/upgrade-infos

Scene Linkage Rules

API NameURL
Get Linkage Rule DetailsGET:/v2.0/cloud/scene/rule/{rule_id}
Query Linkage RulesGET:/v2.0/cloud/scene/rule
Delete Linkage RuleDELETE:/v2.0/cloud/scene/rule
Trigger Tap-to-RunPOST:/v2.0/cloud/scene/rule/{rule_id}/actions/trigger
Modify Linkage RulePUT:/v2.0/cloud/scene/rule/{rule_id}
Enable/Disable AutomationPUT:/v2.0/cloud/scene/rule/state
Add Linkage RulePOST:/v2.0/cloud/scene/rule

Smart Lock Setting

API NameURL
Assign Passwords to Device MembersPOST:/v1.0/devices/{device_id}/device-lock/users/{user_id}/allocate
Get Dynamic PasswordGET:/v1.0/devices/{device_id}/door-lock/dynamic-password
Synchronize PasswordPOST:/v1.0/devices/{device_id}/door-lock/issue-password
Remote Unlocking with PasswordPOST:/v1.0/devices/{device_id}/door-lock/open-door
Get Unlocking RecordsGET:/v1.0/devices/{device_id}/door-lock/open-logs
Create Temporary PasswordPOST:/v1.0/devices/{device_id}/door-lock/temp-password
Get Temporary PasswordGET:/v1.0/devices/{device_id}/door-lock/temp-password/{password_id}
Get Temporary PasswordsGET:/v1.0/devices/{device_id}/door-lock/temp-passwords
Delete Temporary PasswordDELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}
Freeze Temporary PasswordPUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/freeze-password
Modify Temporary PasswordPUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/modify-password
Delete Temporary Password RecordDELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/record
Create Unnamed Temporary PasswordPOST:/v2.0/devices/{device_id}/door-lock/temp-password
Get Temporary KeyPOST:/v1.0/devices/{device_id}/door-lock/password-ticket
Get Bound Unlocking MethodsGET:/v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/assigned-keys
Get Unbound Unlocking MethodsGET:/v1.0/devices/{device_id}/door-lock/unassigned-keys
Enroll in Unlocking MethodPUT:/v1.0/devices/{device_id}/door-lock/actions/entry
Delete Unlocking MethodsDELETE:/v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/unlock-types/{unlock_type}/keys/{unlock_no}
Cancel Enrolling in Unlocking MethodPUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/actions/cancel
Set Duress AlarmPUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/keys/{unlock_no}/hijack
Get Alert RecordsGET:/v1.0/devices/{device_id}/door-lock/alarm-logs
Set Advanced PasswordPOST:/v1.0/devices/{device_id}/door-lock/advanced-password
View Advanced PasswordGET:/v1.0/devices/{device_id}/door-lock/advanced-password
Clear Temporary PasswordsPOST:/v1.0/devices/{device_id}/door-lock/temp-passwords/rest-password
Get the latest remote door opening or alarm cover imageGET:/v1.0/devices/{device_id}/door-lock/latest/media/url
Generate Offline Temporary PasswordPOST:/v1.1/devices/{device_id}/door-lock/offline-temp-password
Synchronize Unlocking MethodsPOST:/v1.0/smart-lock/devices/{device_id}/opmodes/actions/sync
Get Periodic Temporary Passwords of Keepalive LocksGET:/v1.0/smart-lock/devices/{device_id}/stand-by-lock-temp-passwords
Cancel Duress AlertDELETE:/v1.0/smart-lock/devices/{device_id}/unlock-types/{unlock_type}/keys/{unlock_sn}/hijack
Remote Locking and Unlocking Without PasswordPOST:/v1.0/smart-lock/devices/{device_id}/password-free/door-operate
Get Device AlbumsGET:/v1.0/smart-lock/devices/{device_id}/albums-media
Get Temporary KeyPOST:/v1.0/smart-lock/devices/{device_id}/password-ticket
Assign Unlocking MethodPOST:/v1.0/devices/{device_id}/door-lock/opmodes/actions/allocate
Associate History with UserPOST:/v1.0/devices/{device_id}/door-lock/records/{record_id}/actions/allocate
Update Unlocking MethodsPUT:/v1.0/devices/{device_id}/door-lock/opmodes/{unlock_sn}
Update Offline Password NamePUT:/v1.0/devices/{device_id}/door-lock/offline-temp-password/{password_id}
Get Unlocking History/Alert HistoryGET:/v1.0/devices/{device_id}/door-lock/records
Query Video ViewGET:/v1.0/smart-lock/devices/{device_id}/media-view-times
Add One Video ViewPOST:/v1.0/smart-lock/devices/{device_id}/media-view-times
Set Special Attributes of Unlocking MethodPOST:/v1.0/smart-lock/devices/{device_id}/opmodes/{opmode_id}/attribute/{attribute}/opmode-attr
Get the temporary password list of the door lockGET:/v1.0/devices/{device_id}/door-lock/template/temp-password
Create temporary passwordPOST:/v1.0/smart-lock/device/{device_id}/template/temp-password
Delete temporary passwordDELETE:/v1.0/devices/{device_id}/door-lock/template/temp-password/{password_id}
Temporary Password Details InterfaceGET:/v1.0/devices/{device_id}/door-lock/template/temp-password/{password_id}

Device User Mangement

API NameURL
Add Device MemberPOST:/v1.0/devices/{device_id}/user
Query Member List by Device IDGET:/v1.0/devices/{device_id}/users
Modify Device MembersPUT:/v1.0/devices/{device_id}/users/{user_id}
Delete UserDELETE:/v1.0/devices/{device_id}/users/{user_id}
Query Device MembersGET:/v1.0/devices/{device_id}/users/{user_id}
Get User InformationGET:/v1.0/smart-lock/devices/{device_id}/users
Update User ValidityPUT:/v1.0/smart-lock/devices/{device_id}/users/{user_id}/schedule
Delete UserPOST:/v1.0/smart-lock/devices/{device_id}/users/{user_ids}/actions/delete-users-issue
Get List of Unlocking MethodsGET:/v1.0/smart-lock/devices/{device_id}/opmodes/{user_id}
Unbind Assigned Unlocking MethodPOST:/v1.0/smart-lock/devices/{device_id}/opmodes/actions/cancel-allocate

Device Control(Standard Instruction Set)

API NameURL
Get the specifications and properties of the deviceGET:/v1.0/iot-03/devices/{device_id}/specification
Get the instruction set of the deviceGET:/v1.0/iot-03/devices/{device_id}/functions
Get the instruction set of the categoryGET:/v1.0/iot-03/categories/{category}/functions
Send commandsPOST:/v1.0/iot-03/devices/{device_id}/commands
Get Category ListGET:/v1.0/iot-03/device-categories
Get the status of a single deviceGET:/v1.0/iot-03/devices/{device_id}/status
Get the latest status of multiple devicesGET:/v1.0/iot-03/devices/status
Get Status SetGET:/v1.0/iot-03/categories/{category}/status

Smart Access User Management

API NameURL
Delete UserDELETE:/v1.0/access-control/{device_id}/persons/{person_id}
Add PersonPOST:/v1.0/access-control/{device_id}/persons/{person_id}
Update PersonPUT:/v1.0/access-control/{device_id}/persons/{person_id}

Smart Access Face Management

API NameURL
Add Face DataPOST:/v1.0/access-control/{device_id}/persons/{person_id}/faces/{face_id}
Delete FaceDELETE:/v1.0/access-control/{device_id}/persons/{person_id}/faces/{face_id}
Update Face InformationPUT:/v1.0/access-control/{device_id}/persons/{person_id}/faces/{face_id}

Smart Access QR Code Management

API NameURL
Delete QR CodeDELETE:/v1.0/access-control/{device_id}/persons/{person_id}/qrcodes/{qr_code}
Add QR CodePOST:/v1.0/access-control/{device_id}/persons/{person_id}/qrcodes/{qr_code}
Update QR CodePUT:/v1.0/access-control/{device_id}/persons/{person_id}/qrcodes/{qr_code}

Smart Access Card Management

API NameURL
Freeze CardPUT:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}/freeze
Delete CardDELETE:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}
Unfreeze CardPUT:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}/unfreeze
Add CardPOST:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}
Update CardPUT:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}

Smart Access Pass Password Management

API NameURL
Delete PasswordDELETE:/v1.0/access-control/{device_id}/persons/{person_id}/passpwd/{pass_pwd}
Update PasswordPUT:/v1.0/access-control/{device_id}/persons/{person_id}/passpwd/{pass_pwd}
Add PasswordPOST:/v1.0/access-control/{device_id}/persons/{person_id}/passpwd/{pass_pwd}

Remote Door Opening

API NameURL
Send Unlocking CommandPOST:/v1.0/access-control/{device_id}/persons/{person_id}/actions/open

Public Area Device Information

API NameURL
Get Device DetailsGET:/v1.0/expand/devices/{device_id}
Get Device ListGET:/v1.0/expand/devices

Public Area Device Command

API NameURL
Query Command RecordGET:/v1.0/expand/cmds/{sn}

Resident Calling

API NameURL
Call UsersPOST:/v1.0/access-control/{device_id}/persons/actions/call

Public Area Device Permission

API NameURL
Delete Device PermissionsDELETE:/v1.0/expand/spaces/{device_id}/persons/{person_id}
Add Device PermissionPOST:/v1.0/expand/spaces/{device_id}/persons/{person_id}

Smart Access Users Batch Operations

API NameURL
Bulk Add UsersPOST:/v1.0/access-control/{device_id}/persons
Bulk Add QR CodesPOST:/v1.0/access-control/{device_id}/persons/qrcodes
Bulk Delete UsersDELETE:/v1.0/access-control/{device_id}/persons
Bulk Delete FacesDELETE:/v1.0/access-control/{device_id}/persons/faces
Bulk Add FacesPOST:/v1.0/access-control/{device_id}/persons/faces
Bulk Delete QR CodesDELETE:/v1.0/access-control/{device_id}/persons/qrcodes

Device Capability Management

API NameURL
Query Device Capability ListGET:/v1.0/iot-03/devices/{device_id}/capabilities-definition

Public Area Device Function Point

API NameURL
Get Device Function PoolGET:/v1.0/expand/devices/{device_id}/function-pool
Modify Data PointPUT:/v1.0/expand/devices/{device_id}/functions
Get Data Point ListGET:/v1.0/expand/devices/{device_id}/functions

Card Operations

API NameURL
Write Data to CardPOST:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors
Modify Card NamePUT:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors
Get a List of Locks with Offline Password FeatureGET:/v1.0/devices/{device_id}/offline-pwd-locks
Delete Data from CardDELETE:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors
Read Card Data from the CloudGET:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors
Get History of Writing to CardGET:/v1.0/devices/{device_id}/door-lock/card-issuers/cards

Smart water meter switch management

API NameURL
Set Valve OpennessPOST:/v1.0/water-meter/{device_id}/actions/valve-open-degree

Power Management

API NameURL
Query Remaining Battery CapacityGET:/v1.0/iot-03/power-devices/{device_id}/balance-charge
Set Up Enabling Status of Prepayment FeaturePOST:/v1.0/iot-03/power-devices/{device_id}/prepayment
Set Up Balance Alert ThresholdPOST:/v1.0/iot-03/power-devices/{device_id}/balance-threshold
Query Enabling Status of Prepayment FeatureGET:/v1.0/iot-03/power-devices/{device_id}/prepayment
Query Balance Alert ThresholdGET:/v1.0/iot-03/power-devices/{device_id}/balance-threshold
Clear Remaining Battery CapacityPOST:/v1.0/iot-03/power-devices/{device_id}/clear-charge
Query Electricity Top-up HistoryGET:/v1.0/iot-03/power-devices/{device_id}/charge-records
Top Up Electrical DevicePOST:/v1.0/iot-03/power-devices/{device_id}/charge

Historical Track

API NameURL
Get Device Track PointGET:/v2.0/iot-01/tracks/detail
Get Device Track SegmentGET:/v2.0/iot-01/tracks/segments

Alert Management

API NameURL
Query Geofence AlertGET:/v2.0/iot-01/fences/warn/list

Electricity Consumption Statistics

API NameURL
Query Time Trend of Energy DataGET:/v1.0/iot-03/energy/{energy_type}/statistics
Energy Consumption RankingGET:/v1.0/iot-03/energy/{energy_type}/monitors-top
Query Energy-Consuming Devices in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/devices
Query Energy Data TrendGET:/v1.0/iot-03/energy/{energy_type}/monitors-trend
Query Energy Consumption Ranking in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/statistics-top
Query Energy Consumption Trend in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/statistics-trend
Query Energy Consumption TrendGET:/v1.0/iot-03/energy/{energy_type}/devices/statistics-trend
Query Total Energy Consumption in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/statistics-sum
Project Space StatisticsGET:/v1.0/iot-03/energy/{energy_type}/space-count
Query Energy Consumption Ranking in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/statistics/devices-top
Remove Electrical DevicesPOST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices-remove
Add Energy-Consuming DevicesPOST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices
Query Total Energy Consumption of NodeGET:/v1.0/iot-03/energy/{energy_type}/space/nodes/statistics-sum
Summarize Energy Consumption Trend of DevicesGET:/v1.0/iot-03/energy/{energy_type}/devices/nodes/statistics-trend
Query Total Energy Consumption of DevicesGET:/v1.0/iot-03/energy/{energy_type}/device/nodes/statistics-sum

Integrate without Apps

API NameURL
Device ControlPOST:/v1.0/iot-01/voice/users/devices/{device_id}/commands
Discover DevicesGET:/v1.0/iot-01/voice/users/devices
Discover ScenesGET:/v1.0/iot-01/voice/users/scenes
Query Device StatusGET:/v1.0/iot-01/voice/users/devices/{device_id}/status
Control ScenesPOST:/v1.0/iot-01/voice/users/scenes/{scene_id}/commands

Electric energy data management

API NameURL
Get Real-Time DataGET:/v1.0/electric-energy/{device_id}/actions/realtime-data

City Infos

API NameURL
Query City ListGET:/v1.0/iot-03/cities
Get City Information by City IDGET:/v1.0/iot-03/cities/{city_id}
Query City by Longitude and LatitudeGET:/v1.0/iot-03/cities/positions

Device Timer

API NameURL
Enable/Disable Scheduled TaskPUT:/v2.0/cloud/timer/device/{device_id}/state
Query Scheduled TaskGET:/v2.0/cloud/timer/device/{device_id}
Add Scheduled TaskPOST:/v2.0/cloud/timer/device/{device_id}
Modify Scheduled TaskPUT:/v2.0/cloud/timer/device/{device_id}
Bulk Delete Scheduled TasksDELETE:/v2.0/cloud/timer/device/{device_id}/batch
Clear Scheduled TasksDELETE:/v2.0/cloud/timer/device/{device_id}

Device Capability Access

API NameURL
Execute Device CapabilityPOST:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code}
Query Device CapabilityGET:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code}
Execute Device Capabilities in BulkPOST:/v1.0/iot-03/devices/{device_id}/capabilities
Query Device Capability StatusGET:/v1.0/iot-03/devices/{device_id}/capabilities

Gateway Management

API NameURL
Check Failover SupportGET:/v1.0/alps/transfer/is/support
Trigger Gateway FailoverPOST:/v1.0/alps/transfer/trigger
Get Failover StatusGET:/v1.0/alps/{gw_id}/transfer/status

Alarm statistics

API NameURL
Query Alert ChartGET:/v1.0/si/iot-03/alarm-statistics/chart
Query Alert StatisticsGET:/v1.0/si/iot-03/alarm-statistics

Weather

API NameURL
Get Current WeatherGET:/v2.0/iot-03/weather/current
Get 7-day Weather ForecastGET:/v2.0/iot-03/weather/forecast/daily
Get Weather History for the Past 24 HoursGET:/v2.0/iot-03/weather/history24

Device Cloud to Cloud Integration

API NameURL
Register DevicePOST:/v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}/register
Report Device PropertyPOST:/v1.0/iot-03/3rdcloud/devices/{device_id}/property/report
Report Device ResponsePOST:/v1.0/iot-03/3rdcloud/devices/{device_id}/action-resp/report
Get Device InformationGET:/v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}
Update Device InformationPUT:/v1.0/iot-03/3rdcloud/devices/{device_id}
Device Goes OnlinePUT:/v1.0/iot-03/3rdcloud/devices/{device_id}/online
Remove DeviceDELETE:/v1.0/iot-03/3rdcloud/devices/{device_id}/remove
Go OfflinePUT:/v1.0/iot-03/3rdcloud/devices/{device_id}/offline
Report Device EventPOST:/v1.0/iot-03/3rdcloud/devices/{device_id}/event/report
Unbind DevicePOST:/v1.0/cloud/thing/devices/{device_id}/unbind
Report Device DPsPOST:/v1.0/cloud/thing/devices/{device_id}/datapoint/report
Register Sub-devicePOST:/v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}/sub/register

Custom Statistics

API NameURL
Delete Custom Dimension NodeDELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}
Remove Device from Custom Dimension NodeDELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices
Delete MonitorDELETE:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}
Query Device of Custom Dimension NodeGET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices
Query Custom Dimension NodeGET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes
Query Devices Bound with MonitorGET:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices
Query MonitorGET:/v1.0/iot-03/statistical-indicators/monitors
Count MonitorGET:/v1.0/iot-03/statistical-indicators/monitors/devices-count
Add Device to Custom Dimension NodePOST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices
Create Custom Dimension NodePOST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes
Create Custom DimensionPOST:/v1.0/iot-03/statistical-dimensions/{dimension_code}
Modify Custom Dimension NodePUT:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}
Remove Devices Bound with MonitorPOST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices-remove
Bind Devices with MonitorPOST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices
Add MonitorPOST:/v1.0/iot-03/statistical-indicators/monitors
Modify Monitor NamePUT:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}

Integrate with Private Apps

API NameURL
Discover ScenesGET:/v1.0/iot-01/voice/users/{uid}/scenes
Query Device StatusGET:/v1.0/iot-01/voice/users/{uid}/devices/{device_id}/status
Scene ControlPOST:/v1.0/iot-01/voice/users/{uid}/scenes/{scene_id}/commands
Discover DevicesGET:/v1.0/iot-01/voice/users/{uid}/devices
Device ControlPOST:/v1.0/iot-01/voice/users/{uid}/devices/{device_id}/commands

Firmware Management

API NameURL
Query Firmware Version by Firmware KeyGET:/v1.0/iot-03/product/firmware/versions
Bulk Query Firmware Details by Firmware KeyGET:/v1.0/iot-03/product/firmwares
Query Hardware Information by Product IDGET:/v1.0/iot-03/product/hardwares

Smart Access Device Management

API NameURL
Clear Device DataPOST:/v1.0/access-control/{device_id}/actions/cleardata
Sync Device TimePOST:/v1.0/access-control/{device_id}/actions/synctime

Text-to-Speech

API NameURL
Send TTS CommandPOST:/v1.0/aispeech/voice/push

LASER Robot Vacuum

API NameURL
Modify Cleaning Map NamePOST:/v1.0/users/sweepers/file/{device_id}/file-name
Get Link of Real-Time MapGET:/v1.0/users/sweepers/file/{device_id}/realtime-map
Delete Cleaning MapDELETE:/v1.0/users/sweepers/file/{device_id}/clean-history
Get Map File ListGET:/v1.0/users/sweepers/file/{device_id}/list
Get Download Link of MapGET:/v1.0/users/sweepers/file/{device_id}/download

Electric energy alarm threshold management

API NameURL
Set Over-Voltage Protection ValuePOST:/v1.0/electric-energy/{device_id}/actions/voltage-over
Set Power LimitPOST:/v1.0/electric-energy/{device_id}/actions/power-limit
Set Current LimitPOST:/v1.0/electric-energy/{device_id}/actions/current-limit
Set Leakage Alert ValuePOST:/v1.0/electric-energy/{device_id}/actions/leak-warn-value
Set Leakage Action ValuePOST:/v1.0/electric-energy/{device_id}/actions/leak-action-value
Set Electricity Consumption Alert ValuePOST:/v1.0/electric-energy/{device_id}/actions/electric-warn
Set Under-Voltage Protection ValuePOST:/v1.0/electric-energy/{device_id}/actions/voltage-under
Set Over-Temperature Protection ValuePOST:/v1.0/electric-energy/{device_id}/actions/temp-over

Power Safety

API NameURL
Query Electricity Safety RuleGET:/v1.0/iot-03/power-devices/{device_id}/safety-rules
Set Up Electricity Safety RulePOST:/v1.0/iot-03/power-devices/{device_id}/safety-rules
Query Electricity Safety RulesGET:/v1.0/iot-03/power-devices/{device_id}/support-safety-rules

Smart Home Control

API NameURL
Get Home ListGET:/v1.0/iot-01/voice/home/list
Smart Home ControlPOST:/v1.0/iot-01/voice/homes/{home_id}/dm

Location-based service

API NameURL
Reverse GeocodingGET:/v1.0/iot-03/geocode-cities/latitude-longitude
Forward GeocodingGET:/v1.0/iot-03/geocode-cities/address
Get Location by IP Address V1.1GET:/v1.1/iot-03/locations/ip

Campus and Office Asset Management

API NameURL
Transfer DevicePOST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer

Real Time Location

API NameURL
Query Real-time Locations of Multiple DevicesGET:/v2.0/iot-01/tracks/location

Country Code

API NameURL
Get a List of Country CodesGET:/v3.0/iot-03/all-countries

Geographical Fence

API NameURL
Add Devices in GeofencePOST:/v2.0/iot-01/fences/{fence_id}/entity
Create Polygonal GeofencePOST:/v2.0/iot-01/fences/polygon
Modify Polygonal GeofencePUT:/v2.0/iot-01/fences/polygon/{fence_id}
Query Objects in GeofenceGET:/v2.0/iot-01/fences/{fence_id}/entity
Query All GeofencesGET:/v2.0/iot-01/fences/list
Create Circular GeofencePOST:/v2.0/iot-01/fences/circle
Enable or Disable GeofencePUT:/v2.0/iot-01/fences/{fence_id}/open
Query Multiple Private GeofencesGET:/v2.0/iot-01/fences/private/batch
Save Circular Private GeofencesPOST:/v2.0/iot-01/fences/circle/private/batch
Modify Circular GeofencePUT:/v2.0/iot-01/fences/circle/{fence_id}
Query Geofence by Geofence IDGET:/v2.0/iot-01/fences/batch
Save Polygonal Private GeofencesPOST:/v2.0/iot-01/fences/polygon/private/batch

Electric energy switch management

API NameURL
Set Enabling SwitchPOST:/v1.0/electric-energy/{device_id}/actions/hand-enable
Set Circuit SwitchPOST:/v1.0/electric-energy/{device_id}/actions/switch

Product Management

API NameURL
Search for My Product ListGET:/v1.0/products/own/list

Devices Group Management

API NameURL
Get Details of Device Group TasksGET:/v1.0/iot-03/device-groups/{group_id}/tasks

Log Management

API NameURL
Save Operation LogPOST:/v1.0/iot-03/audit/operate-logs
List of Log OperationsGET:/v1.0/iot-03/audit/operate-logs