Example Integration Workflows
The following examples demonstrate common real-world IoT.live integration patterns using the platform APIs.
These workflows are designed to help developers:
- Build integrations faster
- Understand operational sequencing
- Handle async processing correctly
- Implement production-safe automation
[IMAGE PLACEHOLDER: Integration workflow overview]
Workflow Categories
The examples in this section cover:
- Authenticate and Retrieve Inventory
- Suspend a Connection
- Bulk Rate Plan Migration
- Export Usage Reports
- Customer Tagging Workflow
- Async Campaign Processing
- CSV Batch Upload Workflow
- Download Async Reports
- Error Handling and Retry Logic
Authenticate and Retrieve Inventory
This example demonstrates the recommended onboarding workflow for new integrations.
Typical flow:
- Authenticate successfully
- Call listConnections
- Validate API response
- Implement pagination
- Process inventory records
[IMAGE PLACEHOLDER: Inventory retrieval workflow]
Example request
Recommended implementation pattern
Recommended integration behaviour:
- Paginate inventory requests
- Log corrId
- Retry transient failures carefully
- Cache inventory safely
- Export large inventories asynchronously
Suspend a Connection
This workflow demonstrates operational lifecycle management using the Connection APIs.
Typical use cases include:
- Billing control
- Device lifecycle management
- Fraud response
- Temporary service suspension
[IMAGE PLACEHOLDER: Suspend connection workflow]
Example request
Status updates may immediately impact live customer connectivity.
Bulk Rate Plan Migration
This workflow demonstrates large-scale operational migrations using async processing.
Typical scenarios include:
- Billing optimisation
- Pool migrations
- Customer onboarding
- Provider transitions
[IMAGE PLACEHOLDER: Bulk rate plan migration]
Example async migration request
Recommended monitoring
Bulk operational migrations should:
- Monitor async status
- Export failed records
- Review audit history
- Retry partial failures carefully
Export Usage Reports
This workflow demonstrates usage export automation.
Typical use cases include:
- Customer reporting
- BI integrations
- Billing reconciliation
- Usage analytics
[IMAGE PLACEHOLDER: Usage export workflow]
Example request
Customer Tagging Workflow
This workflow demonstrates customer ownership mapping using Tagging APIs.
Typical use cases include:
- Multi-tenant inventory management
- Customer segmentation
- Operational grouping
- Deployment organisation
[IMAGE PLACEHOLDER: Customer tagging workflow]
Example request
Async Campaign Processing
This workflow demonstrates how to handle asynchronous operational processing safely.
Recommended workflow:
- Submit async request
- Receive Pending
- Monitor campaign status
- Export failed records
- Retry where appropriate
[IMAGE PLACEHOLDER: Async campaign lifecycle]
Example async response
CSV Batch Upload Workflow
The platform supports CSV-driven operational workflows using multipart upload APIs.
Typical use cases include:
- Bulk provisioning
- Status changes
- Rate plan migrations
- Customer onboarding
[IMAGE PLACEHOLDER: CSV batch upload workflow]
Recommended CSV workflow
- Generate CSV dataset
- Validate formatting carefully
- Upload using multipart API
- Monitor async processing
- Export failed records if necessary
Invalid CSV formatting may result in partial failures or rejected operations.
Download Async Reports
Large export operations may generate downloadable reports.
Typical workflow:
- Submit export request
- Monitor processing
- Retrieve generated report
- Store report securely
[IMAGE PLACEHOLDER: Async report download workflow]
Example download endpoint
Error Handling and Retry Logic
Production integrations should implement:
- Structured logging
- Safe retry handling
- Async monitoring
- Partial success handling
- Operational alerting
Recommended logging fields include:
- corrId
- Request timestamps
- Result values
- Failed identifiers
- Async campaign IDs
[IMAGE PLACEHOLDER: Error handling workflow]
Retry recommendations
Recommended retry candidates:
- Temporary provider failures
- Async processing delays
- Rate limiting scenarios
Avoid automatic retries for:
- Invalid credentials
- Validation failures
- Unsupported operations
Best Practices
Recommended integration best practices include:
- Use dedicated API users
- Monitor async operations fully
- Validate all API result values
- Paginate large requests
- Export large datasets asynchronously
- Log operational workflows consistently
Operational integrations may affect live customer connectivity and billing workflows. Always validate production changes carefully.