View details of each API key request. This function is available throughout the API Service Manager. Viewing details of API key requests is useful if any data needs to be debugged.
To view API key request details, follow the steps below:
- In the iSAMS Control Panel Module, select the API Services Manager applet.
- In the right hand menu, select the option you want to work with:
- API Services Status. Details of the last five API key requests are listed.
- View Batch API Logs. All batch API key requests are listed.
- View Mobile API Logs. All mobile API key requests are listed.
- View REST API Logs. All REST API key requests are listed.
An example of the screen displayed is shown below:
Use the filters available to display selected API requests:
Filters are not available in the API Services Status screen.
Click
in your selected request.
A popup window is displayed with three tabs:
Request Details. The API Key code and details such as the IP address used for the API request are listed.
Request Data. Lists details of the data sent to the iSAMS server using the API key. For example, the parameters used to extract data.
Response Data. Lists details of the iSAMS server response to the request.
- Select the Request Details tab. An example is shown below:
The tab is split into a number of sections:API Request Details. Details such when the API key was last used and the IP address used for the API request are listed here.
API Request Device. Details of the device used to make the API key request is listed here. This section is not listed in all API key requests.
API Request Key. The API Key code, current status and the request count is listed here.
- Select the Request Data tab. Edit the details listed here, if required. An example of the Request Data tab is shown below:
- Select the Response Data tab. Edit the details listed here, if required. An example of the Response Data tab is shown below:
- Click Print Log in any of the selected tabs to print the information displayed.
- Click Cancel to close the window.