Path to function: Management > API keys
This page allows the creation and management of the keys you can use with the OpenAthens REST API, including the API connector for local authentication and Fetching statistics reports via the API.
At the moment there are three permission levels an API key can be given to restrict what it can do:
This only appears if the function is enabled for your organisation
There may be other permission distinctions added in the future.
Click on the create button at the top of the page, enter a name that describes what you will be using it for, and select the permission level
A key will be generated when you click save.
You can edit the name or permission level assigned to a key by hovering over the key and selecting the edit button that appears. You cannot change the key value or expiry date.
Hover over the key you want to delete and select the remove button.
An expiry date is automatically generated. When it is near, the system will automatically send an email to the address on your account. The first email is 30 days before expiry and as the date approaches the system will email you more regularly. Just as with accounts, the key will not work on the expiry date.
When a key expires or is disabled, any application using it will receive invalid credentials errors from the API. It will not be able to interact with OpenAthens until the key that system is using is updated with a valid one.