Welcome to the Decoder API reference.

The Decoder API allows you to decode raw messages sent by Intesens devices into ready to use JSON data.

The Decoder API is organized around the REST methodology, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors.

All requests are authenticated using a client_id and a client_secret placed in the request headers.

The client_id and client_secret can be retrieved from the Intesens Support Team

Authentication

clientIdHeader

For each API request you must put your client_id in the X-IBM-Client-Id Header.

Security scheme type: API Key
header parameter name: X-IBM-Client-Id

clientSecretHeader

For each API request you must put your client_secret in the X-IBM-Client-Secret Header.

Security scheme type: API Key
header parameter name: X-IBM-Client-Secret

Decode

Transform raw device messages into ready to use JSON documents.

Decode a data frame

Decode a raw data frame from a specified device type.

Authorizations:
clientIdHeaderclientSecretHeader
path Parameters
type
required
string

The type of device

device
required
string

The address of the device

Request Body schema: application/json
date
required
string <date-time>

The payload date

data
required
string

The frame to decode as hexadecimal data

Responses

200

200 OK

400

400 Bad Request

post /decoder/v2/device/{type}/id/{device}
https://api.eu-de.apiconnect.ibmcloud.com/intesens-cloud/capi/decoder/v2/device/{type}/id/{device}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "date": "2018-03-26T09:48:11.465Z",
  • "data": "8c9bbc3e89615e0"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "date": "2018-03-26T09:48:11.465Z",
  • "device": "70B3D5B100000001",
  • "deviceType": "SENSE_Temperature_v1",
  • "eventId": "startup",
  • "resources":
    [
    ]
}