Assign devices
First device activation and assigment
When you receive your first devices, you need to activate them. This process will automatically assign the devices to your manager account.
Assigning a device is also referred to as "taking ownership" of a device in other parts of the documentation.
This concept is known as Device Ownership
.
To activate your device, go to the device activation page, connect your device to your computer, and follow the activation instructions.
You have detailed guides for each device type:
Manage Device Ownerships through API (Intense only)
The device ownerships are only needed for Intense devices, in order to know to which client (you) to push raw data.
Inspirit devices do not need ownerships with the new dataflow.
The API allows manager accounts to assign devices to their account.
Each assignment of a device is referred to as a device ownership and consists of a Device ID
and a timespan:
In device ownerships related endpoints you will get output like this:
{
"id": 12345678,
"start_time": "2024-01-01T06:00:00.000000Z",
"end_time": "2999-12-31T23:59:59Z",
"device": 12345,
"manager": 123,
"device_details": {
"id": 12345,
"device_name": "a1b2c3d4e5f8",
"serial_number": "012345"
}
}
You can only access a device's data if a device ownership exists between the device and your account, and the timespan includes the period you want to retrieve.
There are three useful HTTP endpoints for managing device ownership:
- Get device ownerships: Retrieve device ownerships and use query parameters to filter the results.
- Take device ownership: Assign a device to your account using the device's
serial_number
anddevice_name
(available from the Get device ownerships endpoint) - Release device ownership: Remove the device from your account.
Get Device ID from Serial Number
For nearly all API endpoints concerning devices, you will need to provide the device_id
parameter.
However, in your backend or frontend, you want to manage devices by their serial_number
, which is our recommendation.
To create an internal mapping between serial_number
and device_id
mapping, you can use the List Devices endpoint with the current
query parameter set to true
.
This will list all the devices you own, along with additionnal information such as device_id
and serial_number
.
If you are only interested in a specific device, you can use the serial_number
query parameter to find its corresponding device_id
.