A few months ago we released a new version of our API Tokens that have added security and usability features. These have been working well, and we are finally deprecating the old “Legacy API Keys”. On December 1st, those keys are going to stop working and you’ll want to update any integration that uses the Legacy Key to use the new API Tokens instead.
We’ve created a number of prebuilt API tokens for our most popular third-party integrations:
- IT Glue
- Pax 8
- Warranty Master
If you configured any of the integrations above prior to June 3, 2020, you’ll want to follow the steps below to generate a new prebuilt API token to replace your existing integration’s token.
If you’re using custom integrations over our API outside of the integrations listed above that were configured prior to June 3, 2020, you’ll want to follow the steps below to create a new custom API Token to replace your existing integration’s token.
NOTE: API Tokens are used in the same way that API Keys were used before. If an integration is asking for a Syncro API Key, you will use these API Tokens going forward.
Table of Contents:
To view or manage your existing API tokens or to create a new one, you'll want to head to the 'Profile/Password' section in your user menu, highlighted below:
Next, you'll want to select the 'API Tokens' option:
Generating New API Tokens
Select the 'New Token' option at the upper-right to generate a new API Token:
Next, you'll be presented with the option to generate a pre-built API token with prebuilt App Permissions for our native Syncro integrations. Or, you may select the 'Custom Permissions' tab to create an API Token with permissions that you define:
Let's go ahead and select the 'Custom Permissions' tab and begin creating a new custom API Token. In this example, we've given the token an easily recognizable name for future reference, an expiration, and defined what permissions the API token will have access to.
Note: The permissions selected below are just an example. What permissions you enable or disable will be based on the needs of your custom integration and what data/actions it'll need access to.
Example of a custom API Token below:
With your API Token Name, Expiration, and Permissions set, you'll want to select the 'Create API Token' option.
Once created, you'll be presented with a confirmation page with access to the full key.
Important: this will be your one-time opportunity to access the full key. You'll want to copy and store the key at this stage:
Managing Existing API Tokens
For your existing tokens, you can rename, update the expiration date, or modify the permissions at any time. We offer the ability to clone your existing token and their permissions: