External API Integration
CareMaster has the ability to link to multiple external systems via our API Integration.
This is designed to allow access to multiple data sources within the CareMaster system.
Access Permissions
For new users to use this functionality, the access needs to be granted on a Per User basis.
*Please note this can only be added to Administrator users.
Go To Admin > Access Permissions
Here, you will see all of your Administrators and Coordinator names listed.
Click in the box to the right of your selected user and then select API Access.
Setting up a new API Connection
- Once permission is granted, go to the Admin Menu > Integrations and Apps.
-
Create New App
-
Enter the App name and choose the Access Role level: Admin, Coordinator or Worker.
The Access Role will determine what level of data is available depending on the User level selected.
See the Roles Access Level online resource for more information Click Here
-
It will provide you with the:
-
Client ID
-
Client Secret
-
Access Token
-
Make sure you copy your credentials now. You won't be able to see it again!
Managing your Connected Apps
Once your App is connected, it will appear in the Connected Apps list.
You will further have the ability to Suspend and Reactivate this connection as needed.
Go to Admin > Integrations > Connected Apps to view your app list.
As needed you can Suspend;
And Reactivate:
API Docs
To access the API Doc for your site, please amend your unique CareMaster website link to end with “docs/api”