The coreplus API provides access to multiple endpoints, such as clients, referrers, invoices, draft notes, practitioners, availability slots and appointments. It is a RESTful API, which utilises the HTTP verbs for creating viewing objects. The API is intended for server to server transactions and is not suitable for transactions with publicly available mobile or desktop applications.
If you are a developer looking to create an external consumer server to server application for your coreplus clients, then by signing up for a sandbox account you will get access to your own trial coreplus account on our sandbox server with authorisation credentials.
Our developer website can be found below:
In this article we will discuss:
4. FAQ
Create a coreplus add-on to connect with by API
To create a coreplus add-on you will first need to set up your developer account. Once the account has been created you can now log in and start creating the App connection and generating data in your account for API testings and use.
Set up your account with some test data
Once you have created the add-on (which allows API to access the coreplus data), you will need to generate data to test. There's a multitude of features that you can tailor, such as map appointment types or specialties, as well as personalise any features to make it specific, for your business.
Approval of Add On for production
Once developed, you can contact the Integrations Support Team at integrations@coreplus.com.au and we will get the development team to review the app's API workflow.
For the workflow, you'll just need to detail the add-ons workflow/steps for the coreplus Product Team to review it and get the go-ahead for production publication. This is so our internal development team can confirm the rate and type of calls will not adversely affect our other user's experience.
Below is an example of the information needed for approval:
Endpoints - Availability, Appointment, Client
Page size - 100
Frequency - Availability endpoint every 5 minutes. Appointment and client endpoint when needed or every 10min
Workflow: We call the Availability endpoint every 5min and we update our portal. Then based on the availability we create a new client or use an existing client and book an appointment
Once this flow is reviewed and approved, we can then port it to the Production account (pending written permission for a supervisor user on the production account) and will place the details for the production API consumer ID and secret in the sandbox personal files area to finalise the setup.
FAQ
You can find the answers to the most frequently asked questions HERE
Contacting the Integrations Support Team
If you have any questions regarding the API documentation please do not hesitate to contact the team at Integrations@coreplus.com.au
You may find the below articles helpful when adding your test data:
📝 Getting started with coreplus
Please let us know if you have any questions and don't forget to rate this help article below so that we can continue to improve our support to you!