API Overview
The CSL SIM Insight API provides secure programmatic access to SIM management, reporting, messaging, and operational functionality available within the Portal.
It enables authorised systems to interact directly with your SIM estate, supporting automation and integration into external platforms.
The API is designed for controlled, authenticated, system-to-system communication.
Purpose of the API
The API allows you to:
- Perform operational SIM management actions
- Retrieve SIM configuration and status information
- Access usage and reporting data
- Send and monitor SMS
- Request supported location services
It is intended for integration into:
- Internal operational systems
- Billing and reporting platforms
- Device management systems
- Customer-facing portals
Command and Information Model
The API supports two primary interaction types:
Commands
Commands perform actions that change configuration or operational state.
Examples include:
- Moving SIMs between groups
- Changing SIM status
- Assigning customers
- Updating usage limits
Commands may have immediate operational impact.
Information Requests
Information requests retrieve data without changing system state.
Examples include:
- Querying SIM status
- Retrieving usage data
- Obtaining group configuration
- Checking identifiers and contract details
Information requests are read-only.
Functional Areas
The API is organised into functional capability areas:
SIM Management
Operational changes to SIM configuration and lifecycle.
Information and Reporting
Usage, status, configuration, and historical data retrieval.
SMS Services
Sending SMS messages and retrieving message delivery information.
Location Services
Requesting and retrieving location-based information for supported SIM types.
Security and Control
All API activity:
- Is authenticated
- Is account-bound
- Is logged against your account
Permissions are governed by your account configuration.
Because certain API commands perform immediate operational changes, appropriate safeguards and validation should be implemented within your integrating systems.