Cliniko

Reviewed: 25 September 2024

Cliniko is a complete practice management application used by thousands of healthcare practitioners in more than 95 countries worldwide. Manage schedules, treatment notes, invoices, payments and lots more. It works great for solo practitioners, large teams and anything in between.

Cliniko

Required credentials

If you want to integrate with Cliniko in production or using your own credentials in Leyr Sandbox, we will ask you for following:

  • API Key

leyr-config.png

Getting Cliniko credentials

  1. Login to your account at https://www.cliniko.com/. If you have multiple accounts in your organizations, make sure you are using the one with the admin rights.
  2. From the left navigation menu go to "Settings" (https://your-website/settings)1.png
  3. Go to "Users & practitioners" on the "Our clinic" setting card2.png
  4. Find your user with Administrator rights and click on it3.png
  5. In the user window, scroll down to the API keys section. It might be that your users will not have rights to create API keys by default - enable them by setting the corresponding toggle to "Yes" and updating the user4.png
  6. Once updated, you will notice the API keys section has changed. It now shows the total number of API keys you have created and has a button to manage them. Click on "Manage API keys" button5.png
  7. In the API keys window, click on the "Add an API key" button in the top right corner6.png
  8. In the window that appears, provide a name for your API key (e.g. Leyr Integrations) and click on the "Create API key" button7.png
  9. API key will be generated and displayed on the page. Copy the key and enter it into the "EHR API Key" field in Leyr developer portal8.png

Additional Configuration

It might be that you need additional configuration to enable appointments booking, if it was not configured before. There are two settings to be configured.

Enable online bookings

  1. Go to "Online bookings" on the "Appointments" setting card9.png
  2. Check the "Allow your patients to book appointments online." checkbox if it was not checked before and click on the "Save online bookings settings" button10.png

Display business for bookings

  1. Go to "Business information" on the "Our clinic" setting card and edit information about your business11.png
  2. On the "Edit business" page, scroll to the very bottom, find a toggle called "Display this business in online bookings" and set it to "On". Click on the "Update business" button in the bottom of the page12.png

You are now ready to test and launch your integration with Cliniko via Leyr. Check our API specification for implementation details.

Table of Contents