API Reference
The IoT.live API Reference contains detailed endpoint-level documentation for supported platform APIs.
This section is intended for developers building:
- Production integrations
- Operational automation
- Reporting platforms
- Inventory synchronisation
- Bulk operational workflows
[IMAGE PLACEHOLDER: API reference structure]
Reference structure
The API Reference is organised by operational service area.
Each endpoint page should include:
- Endpoint URL
- Request method
- Request schema
- Example requests
- Example responses
- Result handling
- Async behaviour
- Operational considerations
Endpoint structure
Most endpoints follow this structure:
Example:
Request model
Most API requests inherit authentication fields from RequestAbstract.
Field | Description |
|---|---|
corrId | Optional correlation ID |
username | API-enabled username |
password | User password |
licenseKey | Organisation API license key |
Response model
Most API responses inherit from ResponseAbstract.
Async operations
Some APIs process asynchronously and may initially return:
- Pending
- Partially_Successful
- Failed
Async workflows are commonly used for:
- Bulk operational updates
- Campaign processing
- Export generation
- Large inventory operations
[IMAGE PLACEHOLDER: Async operation example]
Async operations should always be monitored until processing fully completes.
Pagination
Many APIs support pagination using:
Field | Description |
|---|---|
page | Zero-based page number |
pageSize | Number of returned records |
Error handling
API integrations should always validate:
- result
- responseMsg
- Async operation state
HTTP success responses do not always indicate successful operational processing.
Common result values include:
- Success
- Pending
- Failed
- Partially_Successful
- Not_Allowed
- Rejected
Authentication reminder
All API requests require:
- HTTPS
- JSON request bodies
- Valid API credentials
- Organisation API license key
Authentication fields are submitted inside the JSON request body.