Click on a Key Name from anywhere in the API Services Manager to view an API key's properties and usage. This offers a quick view to tell you whether an API key is currently in use along with other useful information.
API key properties and usage are displayed in a popup window. An example is shown below:
The window is split into two sections:
- API Key Properties.
- API Key Usage.
In the API Key Properties section the following information is listed:
Properties | Explanation |
API Key | An API Key code is automatically generated for each API key created. Each API Key code is unique. |
API Key Name | This is given to the API key when it is first created. |
API Key Mode | This identifies the API key as either in 'Development' or in 'Production'. Only third party applications which are ready to go live should be using 'Production' mode. |
API Key Type | Identifies the API key as 'Batch', 'Mobile' or 'REST'. |
API Key State | Indicates whether the API key is currently in use. |
In the API Key Usage section the following information is listed:
Item | Explanation |
API Key Requests | This is the number of requests which have been made with the API key. This is also known in the API Services Manager as the request 'count'. |
Last Request | The date and time that the API key was last used. |
Logging Level | Lists which type of API requests are currently being logged for the API key. |
Total 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 Logging Level used in the API key. |