For an overview of this process, please first go over the Registration page in the Quickstart guide, and the Authentication Overview section.

Request Data

macstringMAC address (optional unless authentication method is MAC&SN). Required for mac&sn authentication method
snstringRequired: Serial number - Has to be unique for devices from the same model
cloud_idStringGUID for the device prepended with a short code assigned to each manufacturer. More details here. Required for cloud_id authentication method
firmware_versionstringRequired: The current version of the firmware on the device. served as the base version for the device.
hardware_keystringRequired: Unique key for each batch of manufactured devices.for each model.
namestringOptional: Default friendly name for the device (can be changed later in the UI of the organization)
detailsobjectOptional: Object containing any custom internal device details.
sub_modelstringOptional: Sub-model name for differentiating similar devices. More details here.
parent_iduuidOptional: 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

idstringUnique ID for this device. Must be saved and used for all future API access
access_keystringUnique access key for this device. Must be saved and used for all future API access
hub_urlstringURL of the hub server assigned to this device.
hub_url_static_certstringURL of the hub server assigned to this device that supports custom SSL certificates
mqtt_hub_urlstringFor MQTT based devices.
Click Try It! to start a request and see the response here!