Register a new device with the system

As soon as a device comes online, it should try to register itself to be able to get configuration and license information.

Some devices might not be connected to an outside network, or the connection may be temporarily down. It is recommended that the device attempts to register after each reboot or at large intervals (e.g. every 24 hours).

Request Data

Name

Type

Description

mac

string

MAC address

sn

string

Serial number

model_id

string

Device Model ID

The ID of one of the models defined in your models list (within your partners portal)

Example: 54683b0b-1f11-4c19-9293-2afce49358a4

firmware_version

string

Current version of the firmware

partner_key

string

Unique key for each registered partner. Available upon registration with Xyte.

During development the following sample key can be used: 11111111-2222-3333-4444-1234567890AB

name

string

Optional : Set a default friendly name for the device (can be changed later in the UI of the organization)

details

object

Optional: object containing information the device wants to save on the server.

This information can be queried via the Get Device Info API]

Request Sample

{
    "partner_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
    "nano_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
    "mac": "11:22:33:44:55:66",
    "sn": "112",
    "model_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
    "firmware_version": "1.0.1",
    "name":"test device"
}

Return Data

Name

Type

Description

id

string

Unique ID for this device. Must be saved and used for all future API access

access_key

string

Unique access key for this device. Must be saved and used for all future API access

Language
Click Try It! to start a request and see the response here!