All Collections
Creating and using an API key
Creating and using an API key

How to produce an API key for developers to gain access to a site's data and work on API linked 3rd party apps.

Shelley Withington avatar
Written by Shelley Withington
Updated over a week ago

The Dentally API

The purpose of the Dentally API is to provide programmatic access to the data stored in your Dentally account.

The developer documentation for the API can be found here:

API Key Security

At Dentally we take security of data very seriously.

When creating an API key you should treat it exactly like your password and keep it secret. Anyone who has access to your API key will be able to access the data stored in your Dentally account.

API keys will automatically expire if they aren't used for more than 2 weeks. If this happens you will receive an error when trying to connect to the Dentally API. You will have to create a new API key to access your data again.

Do not email the key to anyone. If you need to share the key with someone you trust please do so over a secure channel.

You should cycle your API keys on a regular basis and if you think your key is being used by someone without your permission, then you can immediately revoke access from the Settings page in Dentally.

Do not store the key openly or publish it on the internet. It could compromise your security and that of the practice you are working with.

Use of the Dentally API is governed by the Dentally Terms of Service.

Create an API key

Dentally Developer Settings

You can create an API key from Dentally by navigating to Settings > Developer Settings > Generate new token.

Ensure that the scope of your key is strictly limited to the type of data that you need to access.

The key restricts access to data within your practice. For example, if you request an API key for patient data in read mode, you will not be able to update patient details. If you need access to update patient detail data, you need to request a new API key with the additional scope.

Each API key is tied to an individual user.


Did this answer your question?