Device Management API

Click on the following link to open the Saveris Device Management API documentation.

Device Management API can be used to register and configure a new device and its alarm configurations.

The term device in the following page is used for Saveris2 Logger, QSR Logger (aka. Wifi Logger) and for our newest hardware generation the wireless sensor gateway (only gateway, not wireless sensors itself!)

Server URL

The URL for this service is: https://device-management-api.REGION.ENV.savr.saveris.net

The REGION and ENV in the URL should be replaced with the specific region and environment you are using. There are two environments available: "i" for integration and testing, and "p" for production. Furthermore we have three regions: "eu" for europe, "am" for america and "ap" for the apac region.

Security

The Device Management API uses Bearer token authentication. You should acquire a token and use it to authenticate your requests.

To get a token you need to authenticate using a /token endpoint of the Device Management API. Here you will just need to send your username and password in the body and you will receive the idToken.

How to integrate a testo logger in a third party system

1. Generate token to use Device Management API

Use /token endpoint to obtaint the token for the API calls. The token is valid for 24 hours.

2. Create a site (location) and the connect key for the location of the logger

Use /connect-keys endpoint to generate the site (location) and the connect key. The connect key is also used as the accountId to onboard the logger to the site (get it in the wifi). The next steps will always be done inside one site and therefore the api will always require the parameter site for it.

Optionally you can set the timezone for the site by using put /settings/global endpoint.

3. Onboard QSR Logger via hotspot mode

For hotspotmodeprocess press the button of the logger for 3 seconds. The LED should start blinking green. The logger will open a wifi network. Connect to that newly created wifi network named (Saveris2-xxx-xxx-xxx) and open your browser and visit 192.168.1.1l

Input the connect key in the accountId field and the your wifi credentials of your normal network with access to the internet and save it.

After that was done successfully, you now have a working and measuring testo logger in your system. You can check this by using get /devices endpoint

3.1. Configure measurement settings for QSR logger (optional)

Use /devices/{uuid} endpoint (PUT request) to configure the measurement settings of the logger.

3.2. Configure sensors QSR logger (optional)

Use /sensors/{uuid} endpoint (PUT request) to configure sensors.

3.3. Configure device alarms for QSR logger (optional)

Use /devices/{uuid}/alarm-configuration or /sensors/{uuid}/alarm-configuration endpoint (PUT request) to configure sensors.

How to receive measurement alarms (after logger is successfully onboarded)

1. Define the object you want to measure and which sensor you want to use to measure it

Use /measuring-objects endpoint (POST request) to create the measuring objects you want to monitor with the logical channels (logical channels define what you want to monitor) and assign the sensor to the measuring object by defining the sensor channel with the sensor uuid for the logical channel.

Optionally use /measuring-objects/{uuid}/measuring-instruction-set endpoint (PUT request) to update the measurement settings. The parameter defined on the measuring object will always be the leading one over the device parameter

2. Define if and when alarms should be thrown for each object

Use /measuring-objects/{uuid}/alarm-configuration endpoint (PUT request) to configure everything related to measurement alarms.