IoT Portal API Reference Guide

The IoT Portal provides a set of APIs that are used to enable new devices to connect to the IoT portal and to enable mobile and desktop applications to interact with the available data. The transport mechanisms supported by the IoT portal includes MQTT, CoAP, and HTTP. This specification describes a transport agnostic protocol to enable bi-directional communication and monitoring of events and information between logical entities within a system. This protocol provides a standard way to package and transmit information relating to a device, regardless of the communication method used (MQTT, CoAP or HTTP). The following diagram describes the way the client applications and external browsers interact with the server directly and through the Management Portal Users Guide.

The IoT Portal API Reference guide describes the information you will need to start developing your application and connecting your devices to the IoT portal. The information provided below will include:

• A generic description of the TR50 Protocol's message format used on top of MQTT/HTTP interfaces
• The authentication process while connecting to the IoT Portal
• An overview of the MQTT and HTTP interfaces used to communicate with IoT Portal
• IoT portal API reference library for the different programming languages and interfaces (C, JAVA, AT)

By default, 100 API calls are allowed per second. Only Super Ops+ have rights to change it.

SuperAdmins have access to ALL commands across the entire platform, and are not limited to assigned orgs. SuperOps have access to Org Level Commands across ALL orgs, and are not limited to assigned orgs. OrgAdmins have access to all Org Level commands within the orgs they are assigned as OrgAdmin. User Roles defined explicit command access within the orgs they are assigned by the role they are assigned in the org.

---

What's Inside

This guide contains the following: