The Practice Better API is currently in public beta and available to users on paid plans looking to retrieve data from their Practice Better account using a RESTful API.
Currently, there is no charge for the API add-on as it is available to customers in public beta. However, pricing for this add-on will be introduced and applicable to all customers in the near future once the beta period has concluded.
Adding the API Access Add-on
1) Open the My Profile menu in the top-right corner of your portal and select My Subscription:
2) Click View add-ons at the bottom of the My Subscription page:
3) Select API Access from the list of available add-ons:
4) You will be prompted to provide details on your intended use of the API. Our support team will review your request before you'll be able to add the add-on to your account.
Creating an API Key
Once your request has been approved, you'll be able to add the API add-on and create an API Key to programmatically access your account data.
1) Click the Settings & Preferences icon in the top-right corner of your portal and select All Settings & Preferences:
2) Select API Access from the settings menu
3) On the API Access page, click Create key to create your first API key:
4) Enter a memorable name and an optional whitelist if you wish to restrict the use of the API key to specific IP addresses. Click Create to continue:
5) Your API key and secret will be displayed in the next popup. Ensure you store the secret securely as you will not be able to access it once the popup is closed.
Once you've created your key you can get started submitting API requests by following the documentation here.
Making API Requests
In order to retrieve data from your account you'll first need to obtain a token. This can be done by exchanging your Client ID and Client Secret via the Auth Token endpoint. The token has a short-lived lifespan for making requests. Once the token expires you'll need to make another request to the OAuth endpoint to generate a new token.
Running Examples in the Documentation
You can run examples of each endpoint directly in the documentation using the right-navigation pane. You'll first need to generate an OAuth token from the Auth Token page:
Enter the Client ID and Client Secret you obtained in the Creating an API Key section and then click Send API Request to generate a bearer token. Once you've generated a token, you can then use the token when testing other endpoints in the documentation:
Running Examples in Postman
You can also export the API specification and import it into Postman. Navigate to our API Documentation page and click Export in the top-right corner:
Click Original to download the API Specification. Once you've downloaded the specification you can import it into Postman using the following instructions.