This article is for software developers and IT admins who want to integrate the Heydoc Public API into their own systems. Our updated API reference can be found here.

Select a section or question from the following list to find out more about the Heydoc API:


General

What role does a user need to be assigned as to use the Heydoc API?

Roles do not determine who can access the Heydoc API. Any user who has requested an API key from the Customer Success team can sign in and use the API.

How much does it cost to use the Heydoc API?

Access to the Heydoc API is free to use for any of our clinics.

Can Heydoc help our clinic build a bespoke API solution?

Heydoc does not build bespoke solutions for clinics, however we do know
that a number of our clients have used other third-party organisations to
successfully assist them with their software development.

Contact our Customer Success team at support@heydoc.co.uk for more information.

Note: Heydoc accepts no responsibility or liability for the goods
and services provided by third-party companies.


Signing in

How do I sign into the Heydoc API server?

To sign in, you must generate an authentication token and update your HTTP headers. For more information, see here.

Where do I find my API key?

You must request an API key to be generated for you by the Heydoc Customer Success team. To request an API key, email: support@heydoc.co.uk

How long does my authentication token last for?

Authentication tokens last for 12 hours. It is recommended that you sign in at the start of every day.


About the Heydoc API

Why does the Heydoc API use GraphQL?

GraphQL (GQL) is rapidly becoming the API standard across many software development landscapes. Here are a few reasons why GQL is becoming more popular:

  • Allows clients to specify exactly what they want from a server, without any risk of over-fetching nor under-fetching data

  • GQL is very flexible, meaning that changes on the client do not require any extra work on the server

  • You can retrieve many resources in a single request. REST APIs typically require loading from multiple URLs, whereas with GQL you can get all the data your app needs in a single request

  • GQL APIs are organised in types and fields rather than endpoints. This ensures that apps only ask for what is possible, and can provide clear and helpful errors

  • You can still integrate legacy REST systems with GQL APIs

If you want to learn more about the benefits of GQL, you can visit the official GQL website here.

What data is available with the Heydoc API?

You can create, read, update, and delete data from most collections such as:

  • Patients

  • Contacts

  • Bookings

  • Invoices

For a full list of what is available from the Heydoc API, see here.

What data is not available with the Heydoc API?

The Heydoc API library is being constantly expanded on, however there are some collections that are not yet available:

  • Availability

  • Tasks

  • Questionnaires (create)

  • Records (create, update, delete)

For a full list of what is available from the Heydoc API, see here.

What is the Heydoc API request limit?

At the moment you can send the Heydoc API 240 requests per minute. However this is soon being reduced to 120 requests per minute.

How are actions performed using the API displayed in the logs of the UI?

Every action using the Heydoc API is added in the logs, with the account name who performed them displayed as well.

Did this answer your question?