Generating API Keys

What is an API Key?

An API Key is a unique code which allows different apps to talk to one another. By providing an API Key to another app, you are allowing them access to your account.

It is very important to protect your API Keys, as they allow access to your account - just like a password. Be sure to always keep them safe and secure.

Generate an API Key

  1. Go to Practice > Setup > API Keys.
  2. Click on the Generate API Key button.
  3. Select the Locations you want to allow this API Key access to.
  4. Toggle the Status switch to enable the API Key.
  5. Enter a descriptive Note about what app or service is using this key.
  6. Click on the Save Changes button.
  7. Copy and paste the API Key into the appropriate field on the connecting app.

Disabling an API Key

If you're concerned that an API Key has been compromised, or you no longer use an app with a particular API Key, you can easily disable each key.

  1. Go to Practice > Setup > API Keys.
  2. Toggle the Status switch for the appropriate API Key.
  3. Click on the Save Changes button.

Keeping your API Keys safe

Please ensure you:

  • Protect your API Keys like they are your account password.
  • Use a different API Key for each app or integration.
  • Only allow the necessary Users access to the API Keys page.
  • Disable a API Key as soon as it is no longer used.
  • 224
  • 29-Aug-2016
  • 2372 Views