IoT Platform:Register a device

Overview

You can use the following methods to register devices:

• Unique-certificate-per-device verification: Create a device in IoT Platform, obtain the device certificate, and then use the certificate information as the unique identifier. The certificate information includes the ProductKey, DeviceName, and DeviceSecret. Burn the certificate information into the firmware of the device. After the device is connected to IoT Platform, the device can communicate with IoT Platform. For more information, see Unique-certificate-per-device verification.

  The following table describes the protocols over which you can register devices.

  Device	Supported protocol	Device registration	References
  Directly connected devices	MQTT	Register devices over MQTT	Establish MQTT connections over TCP Establish connections over HTTPS
  	HTTPS	Register devices over HTTPS
  Gateways and sub-devices	MQTT	Register gateways and sub-devices

• Unique-certificate-per-product verification: Burn a product certificate to all devices of the product. The product certificate includes a ProductKey and a ProductSecret. You must enable the dynamic registration feature for the product to which your device belongs.

  The following dynamic registration methods are supported:

  • Pre-registration: If you use this method, you must register a device in the IoT Platform console. The device is dynamically registered to obtain a DeviceSecret.

  • Preregistration-free: If you use this method, you do not need to register a device in the IoT Platform console. The device is dynamically registered to obtain a ClientID and a DeviceToken.

    Note

    You cannot implement preregistration-free unique-certificate-per-product verification over HTTPS.

  For more information about how to register a device, see Unique-certificate-per-product verification. Gateway sub-devices support only the pre-registration method. For more information about the registration process, see Gateways and sub-devices.

  The following table describes the protocols over which you can register devices.

  Device	Supported protocol	Device registration	Data format description
  Directly connected devices	MQTT	Register devices over MQTT	MQTT-based dynamic registration
  	HTTPS	Register devices over HTTPS	HTTPS-based dynamic registration
  Gateways and sub-devices	MQTT	Register sub-devices by using Link SDK	MQTT-based dynamic registration for sub-devices

MQTT-based dynamic registration for sub-devices

• Request topic: /sys/{productKey}/{deviceName}/thing/sub/register

• Response topic: /sys/{productKey}/{deviceName}/thing/sub/register_reply

Sample request:

{
  "id": "123",
  "version": "1.0",
  "sys":{
      "ack":0
  },
  "params": [
    {
      "deviceName": "deviceName1234",
      "productKey": "a1234******"
    }
  ],
  "method": "thing.sub.register"
}

Sample response:

{
  "id": "123",
  "code": 200,
  "data": [
    {
      "iotId": "12344",
      "productKey": "a1234******",
      "deviceName": "deviceName1234",
      "deviceSecret": "xxxxxx"
    }
  ]
}

The following table describes the parameters.

The following table describes the error codes.

HTTPS-based dynamic registration for directly connected devices

• URL format: https://iot-auth.${YourRegionId}.aliyuncs.com/auth/register/device

• HTTP method: POST.

  Sample request:

  POST /auth/register/device  HTTP/1.1
  Host: iot-auth.cn-shanghai.aliyuncs.com
  Content-Type: application/x-www-form-urlencoded
  Content-Length: 123
  productKey=a1234******&deviceName=deviceName1234&random=567345&sign=adfv123hdfdh&signMethod=HmacMD5

  Sample response:

  {
    "code": 200,
    "data": {
      "productKey": "a1234******",
      "deviceName": "deviceName1234",
      "deviceSecret": "adsfw******"
    },
    "message": "success"
  }

  The following table describes the parameters.

  Parameter	Data type	Description
  Method	String	The request method. Valid value: POST.
  Host	String	The endpoint that is used to dynamically register devices over HTTPS. Format: iot-auth.${YourRegionId}.aliyuncs.com. ${YourRegionId}: Replace this variable with the ID of the region where your IoT Platform device resides. The following regions support HTTPS-based dynamic registration: all regions except the China (Beijing) and China (Shenzhen) regions. For information about the format of region IDs, see Supported regions.
  Content-Type	String	The encoding format of the upstream data that the device sends to IoT Platform.
  productKey	String	The unique identifier of the product.
  deviceName	String	The DeviceName of the device.
  random	String	A random string.
  sign	String	The signature. You can create a signature by using the following method: Sort all parameters that are submitted to IoT Platform excluding sign and signMethod in alphabetical order, and concatenate the parameters and values in sequence without concatenation operators. Use the signature method that is specified by the signMethod parameter and the ProductSecret of the product to generate a signature. Example: hmac_sha1(productSecret, deviceNamedeviceName1234productKeya1234******random123)
  signMethod	String	The signature method. Valid values: hmacmd5, hmacsha1, and hmacsha256.
  code	Integer	The status code that indicates the result.
  deviceSecret	String	The DeviceSecret of the device.