API Overview
The IoT.live REST API provides secure programmatic access to the IoT.live Connected Device Platform (CDP) aggregation and connectivity management services.
The API enables external systems, automation platforms, and operational tooling to interact directly with IoT.live-managed mobile subscriptions, connectivity providers, operational workflows, and reporting services.
[IMAGE PLACEHOLDER: IoT.live API platform overview]
What the API provides
The IoT.live API supports a broad range of operational and reporting workflows, including:
- Connection inventory management
- Connection lifecycle management
- Rate plan updates
- Communication plan updates
- Usage retrieval
- Audit trail access
- Batch operational workflows
- Billing and invoice operations
- Tagging and customer association
- Campaign and asynchronous operations
The Swagger specification groups APIs into service domains including:
API Group | Description |
|---|---|
CDP Aggregation API | Connection inventory and connectivity management |
Campaign Management API | Asynchronous operational campaigns |
Billing API | Invoice and billing operations |
Audit API | Operational audit events |
Automation API | Automation and orchestration workflows |
SMS API | Messaging-related APIs |
BRM API | Business rules and notifications |
Provisioning API | Provisioning-related operations |
[IMAGE PLACEHOLDER: API service domains]
API architecture
The IoT.live API uses:
- HTTPS POST requests
- JSON request bodies
- TLS 1.2 or higher encryption
- Structured request and response objects
- Account-level authentication
Unlike many REST APIs, IoT.live requests include authentication parameters directly within the JSON request body using a shared base request object.
The API follows a structured JSON-over-HTTP model rather than a traditional Bearer-token REST architecture.
API endpoint structure
IoT.live environments are hosted on regional API endpoints.
Documented examples include:
The Swagger specification currently references:
Core API concepts
Most IoT.live APIs follow a common operational structure:
- Submit a JSON request object
- Include authentication details
- Execute a synchronous or asynchronous operation
- Receive a structured JSON response
The platform standardises:
- Authentication handling
- Response objects
- Error handling
- Pagination
- Export workflows
- Asynchronous campaign processing
[IMAGE PLACEHOLDER: Request and response lifecycle]
Common API capabilities
Connection inventory
Retrieve:
- SIM inventory
- Connection status
- Subscription identifiers
- Rate plans
- Operational states
Key APIs include:
- listConnections
- getConnectionDetails
- listConnectionsStats
Connection management
Perform operational updates such as:
- Status changes
- Rate plan updates
- Attribute updates
- Communication plan changes
Key APIs include:
- editConnectionsStatus
- editConnectionsRatePlan
- editConnectionsAttribute
- editConnectionsCommPlan
Usage retrieval
Retrieve:
- Data usage
- SMS usage
- Voice usage
- Historical billing-cycle usage records
Key APIs include:
- getConnectionDataUsageDetails
- getConnectionSMSUsageDetails
- getConnectionVoiceUsageDetails
Audit and history
Retrieve:
- Operational history
- Connection audit events
- Platform activity
- Historic changes
Key APIs include:
- getConnectionAuditTrail
- listAuditOpsResults
Batch and campaign operations
The platform supports asynchronous operational campaigns for large-scale updates.
Campaign workflows support:
- Bulk operational changes
- Retry handling
- Progress monitoring
- Exportable operational results
Key APIs include:
- initiateOpsCampaign
- pauseOpsCampaign
- resumePausedOpsCampaign
- getOpsCampaignCurrentStatusSnapshot
Tagging and customer association
The API supports:
- Generic connection tagging
- Customer association tagging
- Bulk asynchronous tagging workflows
Examples include:
- Firmware tracking
- Device grouping
- Customer ownership mapping
- Operational segmentation
Authentication model
The API uses a shared request authentication object called:
RequestAbstract
This object includes:
- Username
- Password
- API license key
- Optional correlation ID
Authentication details are included directly inside the JSON request body.
[IMAGE PLACEHOLDER: RequestAbstract authentication model]
Response handling
All APIs return a standard response structure containing:
- result
- responseMsg
- corrId
- responseTime
- version
Possible API result values include:
- Success
- Failed
- Partially_Successful
- Pending
- Rejected
- Not_Allowed
Synchronous vs asynchronous operations
The IoT.live platform supports both:
- Synchronous APIs
- Asynchronous campaign workflows
Synchronous APIs typically:
- Return immediate results
- Handle smaller operational updates
Asynchronous workflows are used for:
- Large bulk operations
- Long-running tasks
- Campaign-based updates
- Large dataset exports
[IMAGE PLACEHOLDER: Sync vs async workflows]
Swagger and API tooling
The platform documentation references:
- Swagger API definitions
- API console environments
- Multipart upload APIs
- Export APIs
- CSV-driven workflows
This allows developers to:
- Explore schemas
- Test requests
- Build integrations
- Automate operational workflows
Recommended onboarding path
For new integrations, the recommended onboarding sequence is:
- Configure API authentication
- Test listConnections
- Retrieve connection details
- Test filtering and pagination
- Execute operational updates
- Implement asynchronous workflows
- Build reporting and export automation