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.

To use the API, you must sign into the Heydoc server by generating an authentication token. This token lasts for 12 hours.

In this article:


Requirements

Before you sign into the Heydoc API, you must have the following:

  • Heydoc account: You will need the password linked to your account

  • API Key: Contact Customer Success at support@heydoc.co.uk and they will generate a unique API Key for you to sign in with


How to sign in

To sign into the Heydoc API, you must generate an authentication token:

  1. Post the following signIn mutation into your server client, replacing YOUR API KEY and YOUR PASSWORD with your actual Heydoc credentials. Note: Remember to keep the quotation marks surrounding both your API key and your password.

    mutation{
    signIn(apiKey:"YOUR API KEY",
    password:"YOUR PASSWORD"){token}
    }
  2. Copy the returned token into your client's HTTP headers using the following code, replacing YOUR TOKEN with the actual token you just generated. Note: Remember to keep the quotation marks surrounding your token.

{"x-token":"YOUR TOKEN"}
Did this answer your question?