Registering a Device (Verification Code Mode)

Typical Scenario

Before connecting a device to the IoT platform, an NA must call this API to register the device on the IoT platform and set a unique identification code (such as IMEI) for the device. Then, the device can use the unique identification code to get authenticated and connect to the IoT platform.

This API applies to devices that use LWM2M/CoAP or devices that integrate the AgentLite SDK.

API Function

This API is used by an NA to register a device with the IoT platform. After registration, the device can connect to the IoT platform.

API Prototype

Method	POST
URL	https://server:port/iocm/app/reg/v1.1.0/deviceCredentials?appId={appId}
Transport Protocol	HTTPS

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
app_key	Mandatory	String	header	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.
Authorization	Mandatory	String	header	Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.
appId	Optional	String	query	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform. Set this parameter to the value of appId of the authorized application.
deviceInfo	Optional	DeviceInfoDTO	Body	Indicates the device data.
endUserId	Optional	String(256)	Body	Identifies an end user. In the NB-IoT solution, this parameter is set to the IMSI of the device.
imsi	Optional	String(1-64)	Body	Indicates the IMSI of an NB-IoT device.
isSecure	Optional	Boolean	Body	Indicates whether the device is secure. The default value is false. In NB-IoT scenarios, if a registered device is an encryption device, this parameter must be set to true. true: The device is secure. false: The device is not secure.
nodeId	Mandatory	String(256)	Body	Uniquely identifies a device. The value of this parameter must be the same as the device ID reported by the device. Generally, the MAC address, serial number, or IMEI is used as the node ID. NOTE: When the IMEI is used as the node ID, the node ID varies depending on the chipset provided by the manufacturer. The unique identifier of a Qualcomm chip is urn:imei:xxxx, where xxxx is the IMEI. The unique identifier of a HiSilicon chip is the IMEI. For details about the unique identifiers of chipsets provided by other manufacturers, contact the manufacturers.
psk	Optional	String(8-32)	Body	If the pre-shared key (PSK) is specified in the request, the IoT platform uses the specified PSK. If the PSK is not specified in the request, the PSK is generated by the IoT platform. The value is a string of characters, including upper-case letters A to F, lower-case letters a to f, and digits 0 to 9.
timeout	Optional	Integer(>=0)	Body	Indicates the validity period of the verification code, in units of seconds. If the device has not been connected to the IoT platform and activated within the validity period, the IoT platform deletes the registration information of the device. The value ranges from 0 to 2147483647. If this parameter is set to 0, the device verification code is always valid. (The recommended value is 0.) The default value is 180. The default value can be configured. For details, contact the IoT platform maintenance personnel.
verifyCode	Optional	String(256)	body	Indicates the verification code of the device. If verifyCode is specified in the request, the specified verifyCode is returned in the response. If verifyCode is not specified in the request, the verifyCode automatically generated by the IoT platform is returned. Set verifyCode when registering a device that has integrated the AgentLite SDK. The value of verifyCode must be the same as that of nodeId.
productId	Optional	String(256)	Body	Identifies the product to which the device belongs. This parameter is used to associate the product model of the device. Either specify this parameter or the following parameters: manufacturerId, manufacturerName, deviceType, model, and protocolType.

DeviceInfoDTO structure

Parameter	Mandatory or Optional	Type	Location	Description
manufacturerId	Optional	String(256)	Body	Uniquely identifies a manufacturer. This parameter, together with manufacturerName, deviceType, model, and protocolType, is used to associate the product model of the device. Either specify this parameter, manufacturerName, deviceType, model, and protocolType, or specify productId.
manufacturerName	Optional	String(256)	Body	Indicates the manufacturer name. This parameter, together with manufacturerId, deviceType, model, and protocolType, is used to associate the product model of the device. Either specify this parameter, manufacturerId, deviceType, model, and protocolType, or specify productId.
deviceType	Optional	String(256)	Body	Indicates the device type. The upper camel case is used, for example, MultiSensor, ContactSensor, and CameraGateway. This parameter, together with manufacturerId, manufacturerName, model, and protocolType, is used to associate the product model of the device. Either specify this parameter, manufacturerId, manufacturerName, model, and protocolType, or specify productId.
model	Mandatory	String(256)	Body	Indicates the device model. This parameter, together with manufacturerId, manufacturerName, deviceType, and protocolType, is used to associate the product model of the device. Either specify this parameter, manufacturerId, manufacturerName, deviceType, and protocolType, or specify productId.
protocolType	Optional	String(256)	Body	Indicates the protocol used by the device. CoAP and LWM2M are supported. This parameter, together with manufacturerId, manufacturerName, deviceType, and model, is used to associate the product model of the device. Either specify this parameter, manufacturerId, manufacturerName, deviceType, and model, or specify productId.
name	Optional	String	Body	Indicates the device name.

Response Parameters

Status Code: 200 OK

Parameter	Type	Description
deviceId	String(256)	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.
psk	String(32)	Indicates a random PSK. If the PSK is carried in the request, it is used. Otherwise, the IoT platform generates a random PSK.
timeout	Integer	Indicates the validity period of the verification code, in seconds. The device must connect to the IoT platform within this period.
verifyCode	String(256)	Indicates the verification code of the device. Devices integrated with the AgentLite SDK must use the verification code to complete IoT platform access authentication. If verifyCode is specified in the request, the specified verifyCode is returned in the response. If verifyCode is not specified in the request, the verifyCode automatically generated by the IoT platform is returned.

Request Example

Method: POST
Request:
https://server:port/iocm/app/reg/v1.1.0/deviceCredentials?appId=*********
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json
Body:
{
  "endUserId": "***********",
  "verifyCode": "****************",
  "nodeId": "****************",
  "deviceInfo": {
    "manufacturerName": "******",
    "manufacturerId": "******",
    "deviceType": "******",
    "model": "******",
    "protocolType": "******",
    "name": "******"
  },
  "psk": "********************************",
  "timeout": 0
}

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "deviceId": "*******",
  "verifyCode": "*******",
  "psk": "*********",
  "timeout": 0
}

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
200	103028	The license pool resources.	The license resources have been used up.
400	100003	Invalid verify code.	The verification code is invalid. Recommended handling: Check whether verifyCode carried in the API request is correct. If verifyCode is not carried in the API request, contact IoT platform maintenance personnel.
400	100007	Bad request message.	The request message contains invalid parameters. Recommended handling: The value of deviceId is not assigned. Set this parameter based on the description of request parameters.
400	100416	The device has already been bounded.	The device has been bound to the IoT platform. Recommended handling: Check whether the device is registered.
400	100426	The nodeId is duplicated.	The value of nodeId is duplicated. Recommended handling: Check whether nodeId carried in the API request is correct.
400	50400	The input is invalid.	An input parameter is invalid. Recommended handling: Check whether parameters carried in the API call request are valid.
401	100025	AppId for auth not exist.	The application ID used for authentication does not exist. Recommended handling: Check whether the value is assigned to app_key in the header of the request structure. If this API is called using HTTP, contact IoT platform maintenance personnel to check whether the name of appId in the header is app_key or x-app-key.
403	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
403	100217	The application has not been authorized.	The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.
403	1010009	app throttle exceed.	The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default). Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.
403	1010005	App_key or access_token is invalid.	The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct.
403	600002	The product not existed.	The product does not exist. Recommended handling: Check whether productId is correct.
500	100001	Internal server error.	An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.
500	100203	The application is not existed.	The authorized application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
500	100412	The amount of device has reached the limit.	The number of devices under the current application reaches the upper limit. Recommended handling: Check whether the number of devices under the current application reaches the upper limit.
500	100441	The amount of nonSecure device has reached the limit.	The number of non-security devices has reached the upper limit.
500	103026	The license is not exist.	The license does not exist. Recommended handling: An internal license error occurs on the IoT platform. Contact IoT platform maintenance personnel.
500	50252	Internal server error.	An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.