Authentication

The PracticeHub API uses API keys to authenticate requests. You can view and manage your API keys in your PracticeHub account under Settings -> Developers. Account owners have access to this by default, however if you wish other users to be able to access this area in your account, you will need to add this as a permission for their security role under Settings -> Security & Permissions.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth and do not allow users access to API keys that should not have it. If your key were to be exposed to someone that should not have access, they will be able to download and delete your data. Once you have created an API key, it is your responsibility to keep this safe.

Use your API key by setting it as a header on all requests. You’ll also need to include a User Agent with the name of your app and contact email address.

x-practicehub-key
x-app-details

User Agent format : mywonderfulapp=help@practicehub.io

This will help us identify inbound requests in the event of troubleshooting.

All API requests must be made over HTTPS. API requests without authentication will fail.