API referenceDevices
Get a device
GET
Returns one device your integration key can reach.
The device has the same shape as in the list. Any other id
returns 404.
integrationKeyheader
AuthorizationBearer <token>Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>.
Konsol issues it.
id*stringFormat
uuidThe device
application/json- response
id*stringFormat
uuiddevice_identifier*stringdisplay_name?string|nullstatus*stringnot_activated: registered, and no activation code has been entered on it.
activated: in use. suspended: paused in the Konsol portal.
decommissioned: retired permanently.
Value in
"not_activated""activated""suspended""decommissioned"activated_at?|When an activation code was first entered on the device.
Format
date-timetrading_ids*array<>The tradings the device is currently assigned to.
created_at*stringFormat
date-timeupdated_at*stringFormat
date-timeExample Request
curl -X GET 'https://api.konsol.my/integration/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "device_identifier": "string", "display_name": "string", "status": "not_activated", "activated_at": "2019-08-24T14:15:22Z", "trading_ids": [ "f974492b-bfc0-4d85-99be-88d5e8ec0ac6" ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}