Table of Contents
Please see our article Choosing an Integration Strategy for a discussion on the various integration options with our devices.
This article is to outline the function and features of the HTTP/HTTPS JSON connector and how they can be used in integrating our devices into a 3rd party platform. Contact our support team for integration documents containing the payloads which will be sent.
The authorization and authentication requirements of many systems can be accommodated.
When using OEM Server - devices send their data to OEM Server in their 'native' protocol, which is raw TCP. OEM Server handles device management including firmware updates, parameter updates, debugging, and controls where this data is then directed.
When using the TCP connector - the raw TCP is simply forwarded to the end server (front-end tracking platform)
When using the HTTP connector, the data is repackaged by OEM Server and the data is sent in JSON format via HTTP POST to the desired endpoint. The end server must respond 200 OK to confirm the message has been received, and then OEM Server instructs the device to delete these messages from its memory, since they have been saved to the server.
Connectors control this in OEM. Connectors can be set up as shown here - Create a Connector
Connector Options - Dynamic Fields
As part of the connector setup, we are able to configure up to 3 headers to be sent as part of the HTTP POST, and several dynamic fields can be included in the URL or headers.
Available dynamic fields:
Custom 1, 2 and 3 are fields which can be set by the user via API call. Contact support for details.
Examples of the use of these fields include:
- Setting the URL to be myserver.com/devices/[SERIAL] - so data from specific serials can be directed to the correct place.
- Sending a plant number or asset rego number etc as part of the payload so it can be matched up on the end platform.
- Per Device Authentication keys/tokens
Authentication, Authorization and Security
The latest generation of our devices connect to OEM over an AES-256 encrypted connection. After OEM, when transmitting to a 3rd party server, the HTTPS connector can be used to ensure complete end-to-end encryption.
Other authorization schemes can be accomodated, for example:
- Basic Authentication - Auth details are sent in the header of the POST
- Per device authentication - such as for the Azure IoT Hub. This makes use of the custom fields to store a key per device. The Azure-IOT Hub Helper can be used to easily load these keys into OEM.
In general - 'single-step' authentication methods can be accommodated. Multi-step methods such as bearer authorization are not available.