An API (Application Programming Interface) enables software applications to communicate and share data. A customized API is specifically tailored to meet unique needs, offering specialized features and functionalities for seamless integration and optimal performance. This document explains the customized API module used in our software, detailing how it enhances system capabilities and provides a flexible, robust solution for your integration needs.
To get started
- Login to your account.
- Go to Settings > Master > User Customize API.
- Click on + button.
- Select the API from API Category list.
- Enter API Name.
- Select Timezone from the list. : The data will be shared according to the selected timezone.
- Enter Frequency Time.
15 minutes is the minimum frequency where you can set to call the request.
For example, once a request has been made then only after 15 minutes I can make a request for the next request.
If the server is client specific then the frequency time can be changed.
- Select Response Type.
- Select the Pull Request Parameters according to your requirement.
- Select Start Date Time from the calendar mentioned.
- Select End Date Time from the calendar mentioned.
- Select IMEI Numbers from the list mentioned.
- Select the Output Data fields by checking the box beside the field names.
- Enter the custom field name which you need, beside the fields you select.
- Enter the Type / Format.
- The changes after you add the fields would be visible in the Request Body Preview and Response Body Preview.
- Click on Save.
To Test the API.
- Go to Settings > Master > User Customize API.
- Click on the Orange Dot in the Test API column of the API which needs to be tested.
- A window would open, where the Test API request parameter values needs to be entered.
- Enter Start Date Time.
- Enter End Date Time.
- Enter IMEI Numbers.
- Click on Test.
