The platform opened the following 5 class interface for developers to call;
In which
:The device class interface "issue command to device" is an interface to control the device,is the most commonly used and most important;
In "Section 4 Command delivery", there is a detailed description of this interface.
If you only need to control a few devices, you can roughly browse this section and skip it.
In addition, it is worth noting that in the private scene, because the device is no longer connected to the platform, developers need to implement device management and control themselves.
In which
:The device class interface "issue command to device" is an interface to control the device,is the most commonly used and most important;
In "Section 4 Command delivery", there is a detailed description of this interface.
If you only need to control a few devices, you can roughly browse this section and skip it.
In addition, it is worth noting that in the private scene, because the device is no longer connected to the platform, developers need to implement device management and control themselves.
InterfaceHTTP protocol,Using any programming language that can make HTTP requests is OK;
The method of interface call is also the same, for different devices, the call method can be reused, only the command is different. Therefore:
The method of interface call is also the same, for different devices, the call method can be reused, only the command is different. Therefore:
If only control the device:
You can only encapsulate a function, pass the device ID (integer) and command (array) as parameters intoIf you need other management operations:
You can encapsulate a class, make device control, grouping, timing task as class methodsInterface call
Interface address:
https://api.thingboot.com/{AppID}/{Interface list path}/?{Other parameters}&sign={sign}&ts={ts}
{AppID} For your application ID (generated by the platform)Please press thePreparationguide to enter the console, in the development settings page to view.
{Interface list path} For the interface path,The path of the command is as follows device/control
{Other parameters} Allow get way to pass in the parameters, such as lang = cn, then use Chinese in the error return
{AppID} For your application ID (generated by the platform)Please press thePreparationguide to enter the console, in the development settings page to view.
{Interface list path} For the interface path,The path of the command is as follows device/control
{Other parameters} Allow get way to pass in the parameters, such as lang = cn, then use Chinese in the error return
Request method: POST [suggested] Some simple commands, you can also use GET method
Required parameters
| Parameter | Name | Description |
|---|---|---|
| sign | Signing |
All requests to the Internet of Things console interface, you need to carry this parameter in the urlsign={sign} The value method: {sign} = md5(md5(developer password) + the above ts parameter) 32-bit string |
| ts | Timestamp |
All requests to the Internet of Things console interface, you need to carry this parameter in the url ts={timestap} Timestamp |
Return information format
Interface classification
| 3.1 | Device class interface | fdsafdsafdsa |
| 3.2 | Product class interface | |
| 3.3 | Group class interface | |
| 3.4 | Tag class interface | |
| 3.5 | Task class interface |
3.1 Device class interface
fdsafdsafdsa
| Name | function | |
|---|---|---|
| Issue Commands to the Device | Control the Device and Issue Commands to It | Document |
| Get device list | Get device list | Document |
| Get device details | Get device details | Document |
| Get device configuration information | Document | |
| Maintain equipment labels | When there are many devices, you may need to use tags to mark them, and a single device can be associated with multiple tags. | Document |
| Maintain device groups | You can add devices to a group for unified management. | Document |
| Retrieve device logs | Get device log list | Document |
3.2 Product class interface
3.3 Group class interface
3.4 Tag class interface
3.5 Task class interface
| Name | function | |
|---|---|---|
| Get task list | Retrieve the task list of the current console | Document |
| Task creation | Task creation | Document |
| Task details | Get the detailed information of the task | Document |
| Modify task | Modify task information | Document |
| Delete task | Delete task | Document |
| Control task | Control the start and stop of tasks | Document |