Creating an API Token

Authentication to the Polarity v5 REST API requires an API Token.

Starting in Polarity Server / Web 5.5.x, administrators have the ability to create API keys to be used to query the Polarity API.  Admins may create more than one key.  The keys will act like “users” and may be granted access to Integrations and Annotation Channels, so the keys may have a tailored experience.

Creating an API Key  

To create a new API key:

1. Navigate to the API Keys page under Server Configuration.

2. Select “Create New API Key”.

3. Select Integrations and / or Annotation Channels that the key should have access to.

4. Select an expiration date (required) and provide a name for the key (required).

The default expiration for API Keys is 30 days.

Once the key is created, a pop up view will display the API key.  Record the token from this pop up.

Be sure to copy the API key, as it will only be displayed once.  

There is no other way to access the API Key.

Adding API Key Permissions

Once the key is created, new permissions can be added to the API Key.  This can be done by adding permissions in the “Permissions” view of an Integration or Annotation Channel or by adding permissions to the key itself.