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