What is SIMPro API?
securely communicate with another application via the web. This means that external applications
are able to send and retrieve information to/from SIMPro via a set of commands which means that
the external application can access information, for example details about a particular SIM or set of SIMs, more quickly and efficiently. The API also allows for sending commands to SIMPro to process such as activating or barring a particular SIM or set of SIMs.
protocol call Basic Authentication. This requires that in order to use the API, the application must use HTTPS and submit a valid username and password to SIMPro (much like how you would login).
By enforcing this authentication, it means that API commands in SIMPro will only ever be available
to those with valid credentials and the correct permissions.
HTTPS. You can call the API using these credentials with Basic Authentication, for example:
# REST API
curl --user yourUsername:yourPassword
# SOAP API
curl --user yourUsername:yourpassword --data '<soapenv:Envelope
<api:getSIMs> <getSIMsRequest/> </api:getSIMs> </soapenv:Body>
If the credentials are incorrect or the user does not have the correct
permissions then SIMPro will send an unauthorized response (401) and will
not process any command.
Example Information Available
more technical detail about the API and for all commands/information available, please see the full
API documentation available under the Help menu in SIMPro.
SIM Lifecycle Management
of the SIM Lifecycle Management API the following commands are available:
• Cancel SIM
• Enable/Disable Bar
• Enable/Disable Roaming
- Tariff name
- Tariff description
- Tariff contract length
- Sim cost
- Inclusive values – GPRS, SMS, Voice, etc.
The invoice API allows the retrieval of information about an invoice for a chosen account. Example
invoice information available:
- Invoice reference
- Usage costs – GPRS, SMS, Voice, Roam GPRS, etc.
- Usage values – GPRS (MB), SMS, Voice (minutes)
The SIM API retrieves information about SIMs from a chosen account. Example SIM information
- Tariff Name
- Mobile network operator
- Activation Date
- Last seen
- NetPro usage
- Location information
In addition to retrieving information about given SIMs, you can also get a list of all SIMs on a given account.
- Customer solution name
- Billing account
- Roaming enabled
- Voice enabled
- Customer tariff name
- Push API
The push API allows certain information to be pushed to an external application from SIMPro when
it is triggered from inside of SIMPro. This means the external application would not have to make a request and instead just waits to receive information. Example information that can be pushed from SIMPro:
- Usage alerts – when a SIM hits a pre-defined usage threshold
- SIM status changes