REST API

REST API

/IOTCONNECT™ APIs provide full programmatic access to all platform features. Use OAuth 2.0 Bearer tokens for authentication. Click UAT or PROD links on any service card to open interactive Swagger documentation.

Prerequisites

Before using /IOTCONNECT™ REST APIs, ensure you have:

Solution Key: Contact the IoTConnect support team to obtain your solution key. Save it securely.

Company Registration: Register via subscription.iotconnect.io, AWS / Azure Marketplace, or contact the IoTConnect team.

Username and Password: Received after company registration. Used to generate your access token.

API Base URL: Use the UAT or PROD links below depending on your environment.

How authentication works

/IOTCONNECT™ uses OAuth 2.0. All API requests require a valid Bearer token in the Authorization header.

Generate: Call GET /api/v2.1/auth/basic-token to get a basic token.

Authenticate: POST /api/v2.1/auth/login with basic token in header + credentials in body. Returns access_token + refresh_token.

Consume: Use Bearer {access_token} in Authorization header for all API calls.

Renew: POST /api/v2.1/auth/refresh-token when access token expires.

REST API

Master

Manage FAQs, country/state info, property types. Add, update, delete, and retrieve data elements for platform configuration.

UAT || PROD

Authenticate

Securely authenticate Web API requests with bearer token. Includes login, token generation, refresh, verification, and mobile login.

UAT || PROD

User

Handle user, role, and entity modules. Add, update, delete, and retrieve data for user management and customization.

UAT || PROD

Device

Device modules — add, update, delete devices, certificates, commands, templates, telemetry export, lifecycle tracking, and diagnostics.

UAT || PROD

Firmware

Manage firmware, OTA updates, and deployments. Add, update, deprecate firmware. Manage upgrades and IoT Edge deployments.

UAT || PROD

Event

Manage subscriptions, notifications, templates. Add, update, delete event templates and subscriptions. Enable email sending.

UAT || PROD

Telemetry

Device-cloud communication via MQTT/HTTPS. Retrieve sensor data, telemetry history, template info, and attribute data.

UAT || PROD

File

Manage files — upload, update, delete. Bulk file upload and retrieve file URLs for device telemetry.

UAT || PROD

Master

Manage FAQs, country/state info, property types for Azure deployments.

UAT || PROD-US || PROD-EU

Authenticate

Securely authenticate Web API requests with bearer token for Azure environment.

UAT || PROD-US || PROD-EU

User

Handle user, role, and entity modules for Azure environment.

UAT || PROD-US || PROD-EU

Device

Device modules for Azure deployments.

UAT || PROD-US || PROD-EU

Firmware

Firmware and OTA for Azure deployments.

UAT || PROD-US || PROD-EU

Event

Event management for Azure deployments.

UAT || PROD-US || PROD-EU

Telemetry

Telemetry APIs for Azure deployments.

UAT || PROD-US || PROD-EU

File

File management for Azure deployments.

UAT || PROD-US || PROD-EU

ⓘ NOTE

Required Headers:
– Authorization: Bearer {access_token} (all protected endpoints)
– Content-Type: application/json (POST / PUT requests)
– solution-key: Your solution key GUID (login endpoints only)

SETTINGS > KEY VAULT

for your Solution Key, CPID, and Environment values.