Important!
It is very important to protect API Keys, as they allow account access - just like a password. Be sure to always keep them safe and secure.
What is an API Key?
An API Key is a unique code which allows different apps to talk to one another. Providing an API Key to another app allows them account access.
Generating an API Key
- Go to Setup > Connections > API Keys.
- Click Generate API Key.
- Select the appropriate Locations that this API Key will have access to.
- Toggle the Status switch to enable the API Key.
- Enter a descriptive Note about what app or service is using this key.
- Click on the Save Changes button.
- Copy and paste the API Key into the appropriate field on the connecting app.
Disabling an API Key
If there is concern that an API Key has been compromised, or a particular API Key is no longer in use, we recommend disabling the API key by following the steps below.
- Go to Setup > Connections > API Keys.
- Toggle the Status switch for the appropriate API Key to Key Disabled.
- Click on the Save Changes button.
Keeping your API Keys safe
Please make sure to:
- Protect your API Keys like they are your account password.
- Use a different API Key for each app or integration.
- Only allow necessary Users access to the API Keys page.
- Disable an API Key as soon as it is no longer being used.