REST API

REST API

img
img

Master

The IoTConnect master API offers methods for managing FAQs, country and state info,
property types, and more. It supports operations like adding, updating, deleting, and retrieving data
elements, enhancing customization and configuration within the platform.

 

Authenticate

Use the IoTConnect authenticate API to securely authenticate Web API requests with a
bearer token sent in the Authorization header. API methods include login, token generation, refresh,
verification, and mobile login.

 

User

The IoTConnect user API handles user, role, and entity modules, supporting
operations for adding, updating, deleting, and retrieving data elements. It thus enhances user management
and customization within the platform.

 

Device

The device API handles device modules, supporting functions like adding, updating,
deleting devices, certificates, commands, templates, telemetry data export, device lifecycle tracking, and
direct method execution for device control and monitoring.

 

Firmware

The firmware API manages firmware, OTA updates, and deployments, with methods for
adding, updating, and deprecating firmware. It also manages upgrades and IoT Edge deployments. It requires
headers like Authorization and Content-Type for communication.

 

Event

The event API manages subscriptions, notifications, templates, user device
registration, and more, with methods for adding, updating, and deleting event templates and subscriptions.
It also enables email sending and retrieving event-related details.

 

Telemetry

The IoTConnect telemetry API enables communication between devices and the cloud
through HTTP(S) and MQTT protocols. It offers methods for retrieving device sensor data, telemetry history,
template information, and managing attribute historical data.

 

File

The IoTConnect file API allows users to manage files by providing uploading,
updating, and deleting methods. It also offers features like bulk file upload and retrieving file URLs for
device telemetry.