What are API keys?
An application programming interface (API) is a piece of software that enables computer systems to communicate with each other.
An API key is a code used to identify and authenticate an application or user when calling an API. They are commonly used to control and track how an API is used. This is often as a precaution to prevent abuse or malicious use.
How does Peak use API keys?
Peak uses an API key to provide authentication when establishing an API connection to an external system and when performing processes such as data ingestion and export.
They are generated and managed in the Console area of the platform.
Setting up an API key on Peak
You will need to create a new API key in the following circumstances:
If your Peak organization is new.
If an existing API key has expired.
Keys are valid for three months.
Up to two API keys can be added to Peak.
To add an API key:
Go to Console > Access Tokens.
The Access Tokens screen enables you to add and view API keys, application tokens and external credentials for your Peak organization.
In the API keys pane, click ADD.
Peak generates an API key.
Copy the full key to use it in your applications.
Deleting API keys
To delete a key, hover over it and click the trash icon.
Expired keys and extensions
API keys are valid for three months.
If a key is due to expire, you can create a new one or contact Peak Support to request an extension.
Creating a new key
When you create a new API key, you will have to replace it everywhere it is used on Peak.
Requesting an extension
To request an extension, create a support ticket:
Click the Support icon.
This is located at the top right of Peak, next to your organization name:
The Peak Support portal appears.
Click New Support Ticket and submit your request.