Getting started
API Base URL
Each API endpoint builds on top of the base URL https://api.deconta-connect.com/
Base URL
https://api.deconta-connect.com/ ...
Example URL
https://api.deconta-connect.com/device/latest ...
API Login Name
Your API login is also your login for the deconta-connect platform. To obtain an API login, register at https://www.deconta-connect.com
Base URL
https://api.deconta-connect.com/ ...
Example URL
https://api.deconta-connect.com/device/latest/measurement ...
Example URL with Login
https://api.deconta-connect.com/device/latest/measurement
? login = api.demo@deconta-connect.com
...
API Client ID
You can find your Client ID in the API menu on the https://www.deconta-connect.com platform
Base URL
https://api.deconta-connect.com/ ...
Example URL
https://api.deconta-connect.com/device/latest/measurement ...
Example URL with Client ID
https://api.deconta-connect.com/device/latest/measurement
? login = api.demo@deconta-connect.com
? client = 1234567890
...
API Key
You can find your API Key on your Profile on the https://www.deconta-connect.com platform
Base URL
https://api.deconta-connect.com/ ...
Example URL
https://api.deconta-connect.com/device/latest/measurement ...
Example URL with API Key
https://api.deconta-connect.com/device/latest/measurement
? login = api.demo@deconta-connect.com
? client = 1234567890
? token = 12345678-1234-1234-1234-987654321001
...
API Reponse
We constantly try to use clear identifiers to present all data as comprehensibly as possible. This ultimately causes a higher volume of data, but the identifier is self-explanatory for you. All data is returned in the standard JSON format, so that it can be easily processed in any programming language. Each API response contains a success and a date identifier. The success identifier indicates the successful execution of the API call. The date identifier always shows the date and time when the data packet was generated on the device. The date identifier is always formatted UTC (±0), so you can easily convert the date to your time zone.Example Response: API Endpoint "... /device/latest/measurement"
{
"success": true,
"date": "2021-04-09 08:33:24",
"data": {
"negativePressure": "0",
"filterPressure": "0",
"volumeFlow": "0",
"power": "0",
"current": "0",
"filterLoad": "0",
"powerControl": "0",
"negativePressureControlMinDay": "0",
"negativePressureControlMinNight": "0",
"negativePressureControlMax": "0",
"volumeFlowControl": "0"
}
}
API Endpoints
The currently available API endpoints:Latest Measurement endpoint Returns the latest Measurement document received by the deconta-connect cloud
Device Control endpoint Transmits a control command to your device
Latest Error Message endpoint Returns the latest Error document received by the deconta-connect cloud
Potential Errors
Whenever an API call fails, an explicit error is returned. The error always contains the error code and an error description. All data is returned in the standard JSON format, so that it can be easily processed in any programming language.Example Error Response
{
"success": false,
"error": {
"code": 405,
"info": "You have reached your request limit. (1/min)"
}
}
Error codes
| Error Code | Error Description |
|---|---|
| 101 | No login was specified, or invalid email address was specified |
| 102 | No client was specified, or invalid client was specified |
| 103 | No API key was specified, or invalid API key was specified |
| 201 | Client validation failed |
| 301 | No device article was specified, or invalid device article was specified |
| 302 | No device serial was specified, or invalid device serial was specified |
| 303 | Device validation failed |
| 304 | The specified device can not be found |
| 305 | The control value exceeds the limits of the device |
| 404 | The requested resource does not exist |
| 405 | Your request limit has been reached (10/min) |
| 501 | The specified device is not linked to your user account |