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