In-Store APIdevice-authentication

Device Activation

This endpoint performs a one-time activation of a device, providing a device’s identification and authorization credentials. The device credentials obtained from the activation request should be securely stored on the device. The device credentials are required to create access tokens used for authentication.

Response

If activation is successful, returns the newly activated device’s authorization credentials.

ParameterDescription
deviceIdA device ID required for auditing and authentication.
keyA secret key required for authentication.

Errors

If activation is unsuccessful, returns an Error object. Please refer to the message property for a description of the error.

The following are example error responses for this endpoint.

Status CodeTypeDescription
401unauthorizedWill be returned if the secret is invalid for the device name.

Connection Timeouts

TimeoutTime (seconds)
Open10
Read20

Example Success Response

201 Created
1{
2 "deviceId" : 1234,
3 "key" : "YHe_Qb_uCX4I2NMP4jEM_1x4O2J4w7oFHFSYC28Ulnd0"
4}

Example Error Response

401 Unauthorized
1{
2 "errorCode" : "unauthorized",
3 "errorId" : "c1e565c63429b57d",
4 "message" : "Invalid Secret",
5 "httpStatusCode" : 401
6}