Edit batch API keys to ensure that API key information is kept up-to-date. For example, you may want to adjust the key throttling settings for an API key. You cannot change the API key code.
To edit a Batch API Key follow the steps below:
- In the iSAMS Control Panel Module, select the API Services Manager applet.
- Select ManageBatch API Keys from the right hand menu.
The Manage Batch API Keys screen is displayed:
- Click
in your selected API key. A popup window is displayed:
Select the Key Properties tab. Edit the fields displayed:
Field
Explanation
API Key Name
Enter a clear and concise name for the API key. For example, the name of the third party who is using the API key.
Description
Add a description to provide more detail on the use of the API key. This is optional.
API Key State
Select 'Active' for the third party to start using the API key.
API Key Mode
Select 'Development'. This ensures that any changes made to data are not saved in your iSAMS system. It is not recommended that you select 'Production' until you are ready to go live with the third party application.
API Key Cache Expiry
Select the period of time that information requested from your iSAMS system is cached. This prevents requested data being constantly updated which could slow iSAMS down. For example, select '24 Hours' and all data requested from iSAMS using this API key is cached for 24 hours.
Either:
- Click Save & Close.
or - Edit details in another tab. Choose from:
- Click Save & Close.