-
Posts
-
Using the ClinicOffice API
In June 2023 we launched the much anticipated ClinicOffice API, a RESTful API which allows programmers to integrate ClinicOffice with other applications. Please note: this feature is only available if you are on the Hosted Edition of ClinicOffice.
Please follow the steps below to setup the API:
STEP 1 – Login to the Client PortalBefore you can use the API, you will need to enable it on your account. This is done from your Client Portal. The Client Portal is a website which allows ClinicOffice customers to manage their licenses, SMS credits, and other account related information.
Click here to login to your CLIENT PORTAL
If you’re the account owner and you HAVE used this website before, you will be able to logon with your email/password. If you’ve forgotten those details, please click the “Forgotten password” link or contact us.
If you’re the account owner and you HAVE NOT used this website before, you will need to click “Logon with Account Details” rather than with an email/password. If you don’t know your account details, please contact us and we will provide them for you.
If you are NOT the account owner, please get in touch with whoever is so that they can provide you with login details.
Step 2 – Enable the API for the database
Once you have logged in, click on the My Account button, and look for the API section as shown below.
Toggle the Enable API switch to turn the API on.
The Use Whitelist switch controls whether or not calls made to the API must come from a whitelisted IP address. The whitelist is the same one used by the Clinic to control connections to the ClinicOffice main application.
The username and password are unique to that database. You can generate a new password at any time, but doing so will break any existing integration that’s using the old details.
Step 3 – Test
If you have enabled the API correctly, then you’ll be able to test it live via this page. Please go to: https://api.clinicoffice.online/docs
You will see documentation here for each of the API endpoints. You can also click the “TRY IT OUT” button on the endpoints to test the API calls and see the results. Note that when you click “TRY IT OUT” then “Execute”, you will be prompted for a username and password for the API. This is the same information indicated in STEP 2.
*** IMPORTANT NOTE ***
The ClinicOffice API is designed for programmers who are familiar with RESTful APIs. If you need help connecting to the ClinicOffice API then by all means contact us and we’ll be happy to assist, but please note that we can’t support other programmers in how to write integration code.
- You must be logged in to reply to this topic.