¶ Introduction
Orbit Mobile Limited offers access to systems via a dashboard and some systems functions exposed via RESTful API. Available APIs are documented here and this section gives an introduction to using the APIs.
¶ Tools
Requests to our APIs are sent on HTTPS and information is formated in JSON. Below are the tools we use when sending request for testing before integrating the logic into an application.
- Postman
We prefere using Postman as it makes collaboration easier. It is easy to setup and available to be installed on all platforms. - Curl
Command line funs can use the curl command to interact with our API before implmenting the logic into the application.
¶ Registration
Before sending any request to our TEST or PRODUCTION API, your account needs to be created and given access to use the respective APIs. When access is given to use the respective API, you will receive an API key and username to use via email.
You can generate more API keys on the Dashboard. The following functions are also available on the dashboard:
- Delete an API key
- Disable an API key
- Restrict an API key
¶ API Keys
All requests to the API are authenticated and only processed when a valid combination of username and password are provided. All API requests follow the below general format:
{
"auth": {
"username":"Username",
"key":"API_KEY"
},
"request":{
"query":"query_name",
"params":{
}
}
}
Details of what to send in the query and params field and object are detailed unser each API section.
¶ End Points
Below is the URLs list of our available APIs.
¶ Test
- BMS API : No Files https://test-bms.orbitmobile.co.zm/json.php
- BMS API : Allow Files https://test-bms.orbitmobile.co.zm/file.php
- PROMO API : No Files https://test-switch.orbitmobile.co.zm/ws/promo/json.php
¶ Production
- BMS API : No Files https://bms.orbitmobile.co.zm/json.php
- BMS API : Allow Files https://bms.orbitmobile.co.zm/file.php
- PROMO API : No Files https://switch.orbitmobile.co.zm/ws/promo/json.php
¶ Conclusion
This section provides the basic information on the requirements for you to start sending requests to our APIs. For any queries you can send them to :
it-support@orbitmobile.co.zm 