How Requests Work
The CSL SIM Insight API operates using secure HTTPS requests.
Each request:
- Is submitted to the API endpoint
- Includes authentication credentials
- Contains a structured payload
- Returns a structured response
The API follows a request–response model.
Transport Protocol
All API communication uses:
- HTTPS
- Secure socket connections
Requests must be sent over HTTPS. Non-secure connections are not supported.
Request Structure
Each API call consists of:
- An authenticated request
- A structured payload defining the command or information request
- Required identifiers (for example ICCID or MSISDN where applicable)
The payload defines:
- The action to perform
- The parameters required
- Any configuration values being set
The exact structure depends on the command or query being executed. Full examples are provided in the reference sections.
Identifying SIMs
Where a request relates to specific SIMs, they are typically identified using:
- ICCID
- MSISDN (telephone number), where supported
Multiple SIMs may be included in a single request, depending on the command being used.
Response Structure
Every API request generates a structured response.
Responses indicate:
- Whether the request was successful
- Any validation errors
- Any processing errors
- Requested data (for information queries)
Responses must be parsed and validated within your integrating system.
Processing Model
Commands that modify SIM configuration:
- Are processed immediately
- May have direct operational impact
Information requests:
- Do not modify system state
- Return data available at the time of request
It is important that integrating systems:
- Validate inputs before submission
- Handle error responses appropriately
- Log all outbound requests and inbound responses