Manage Batch API Logging

Use the Manage Batch API Logging option to view and edit which types of API requests are logged for each batch API key. You may want to limit the options selected to prevent iSAMS being clogged with data. The status of each API key and the number of requests using each API key is also listed here.

To use Manage Batch API Logging, follow the steps below:

1. In the iSAMS Control Panel Module, select the API Services Manager applet.

2. Select Manage Batch API Logging from the right hand menu.
   The Manage Batch API Logging screen is displayed:
   
   A number of columns of information are displayed for you. Check boxes are also listed for each API key. Each column is explained in the table below:

   Column	Explanation
   Key Name	Click on a selected Key Name to display key properties and usage. See API Key Properties and Usage for an explanation of the information displayed.
   API Key Description	Details of the API key. This field is optional so may be blank.
   Status	Indicates whether the API key is currently in use.
   Requests	This is the number of requests which have been made with the API key. This is also displayed as the request 'count'.
   Logs	This is the number of request logs which have been made for the API key. The number of requests logged is determined by the check boxes selected.

3. Use the check boxes available to edit which API requests are logged:
   
   • None. No API requests are logged. Requests are still included in the request count. Select this once the API key is working as expected with no fatal requests or errors.
   • Fatal. API requests which could not be fulfilled due to a fault with iSAMS. Occasionally, iSAMS may contain bugs which need to be corrected. Contact the Help Desk if you continue to experience this.
   • Error. API requests which could not be fulfilled due to a fault with the third party's information. For example, dates of birth were not provided in a format recognised by iSAMS.
   • All Rqs. All API requests are logged; this includes successful, fatal and error API requests.
4. Click Save Batch Key Logging to save your selections.