post https://entry.xyte.io/v1/devices
For an overview of this process, please first go over the Registration page in the Quickstart guide, and the Authentication Overview section.
Request Data
Name | Type | Required | Description |
---|---|---|---|
mac | string | See description | MAC address (optional unless authentication method is MAC&SN). Required for mac&sn authentication method |
sn | string | Yes | Serial number - Has to be unique for devices from the same model |
cloud_id | String | See description | GUID for the device prepended with a short code assigned to each manufacturer. More details here. Required for cloud_id authentication method |
firmware_version | string | Yes | The current version of the firmware on the device. served as the base version for the device. |
hardware_key | string | Yes | Unique key for each batch of manufactured devices.for each model. |
name | string | Default friendly name for the device (can be changed later in the UI of the organization) | |
details | object | Object containing any custom internal device details. | |
sub_model | string | Sub-model name for differentiating similar devices. More details here. | |
parent_id | uuid | UUID of a registered parent device for Application Devices. |
Request Sample
{
"hardware_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
"cloud_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
"mac": "11:22:33:44:55:66",
"sn": "112",
"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 |
hub_url | string | URL of the hub server assigned to this device. |
hub_url_static_cert | string | URL of the hub server assigned to this device that supports custom SSL certificates |
mqtt_hub_url | string | For MQTT based devices. |