English
English
简体中文
Contact Us
Register
Log In
layoutIndex

IoT Core

Last Updated on : 2022-09-28 10:56:06download

IoT Core provides the fundamental device connection and device management. The secured and reliable connection between your IoT application and devices allows to monitor and to manage your IoT assets.

General Devices Control

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

General 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
Query the factory information of multiple devicesGET:/v1.0/iot-03/devices/factory-infos
Get Device InformationGET:/v1.1/iot-03/devices/{device_id}
Get Device ListGET:/v1.2/iot-03/devices
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

General Devices status

API NameURL
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

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 Assets to a UserPOST:/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 Information 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

Home Management

API NameURL
Add HomePOST:/v1.0/home/create-home
Search FamilyGET:/v1.0/homes/{home_id}
Modify HomePUT:/v1.0/homes/{home_id}
Delete FamilyDELETE:/v1.0/homes/{home_id}
Query the list of devices under the familyGET:/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 user family 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 the device in the room under the familyDELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices

User Management

API NameURL
Sync UsersPOST:/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

Application Management

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

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}

Device Management

API NameURL
Query Zigbee devices under the gatewayGET:/v1.0/devices/{deviceId}/sub-devices
Batch query equipment factory informationGET:/v1.0/devices/factory-infos
Get Device ListGET:/v1.0/devices
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}
Remove deviceDELETE:/v1.0/devices/{deviceId}
Get User's Device ListGET:/v1.0/users/{uid}/devices
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

Device Control

API NameURL
Modify function point namePUT:/v1.0/devices/{device_id}/functions/{function_code}
Control DevicePOST:/v1.0/devices/{deviceId}/commands
Get the instruction set supported by the deviceGET:/v1.0/devices/{deviceId}/functions
Get device specification attributesGET:/v1.0/devices/{deviceId}/specifications
Get the instructions set by categoryGET:/v1.0/functions/{category}
Get the instruction sets in bulkGET:/v1.0/devices/functions
Get Device Specification AttributeGET:/v1.1/devices/{device_id}/specifications