Skip to main content

How to get a Nookal API key

This information is based on the official instructions from nookal. If these instructions are out of date, please refer to the official instructions. 

API keys are very powerful, they can potentially enable full access to all of your business information. Please make sure you reviewed the API key safety tips to ensure you aren't putting your business at risk.

Nookal Integration and API Keys

The preferred method is to use the key generated by Nookals The BOS Integration. 

If this doesn't work for you then an alternative is to use a Nookal API key. 

Method 1: Nookal Integration

  1. Go to Setup > Connections > Integrations
  2. Find 'The BOS' and tick the integration to enable it. 
  3. Click 'configure' to get the API key
  4. Copy and paste this key into the appropriate field in The BOS

image.png

image.png

Method 2: API Key

Only use this if Method 1 isn't working. 

You can't generate a key for "all locations", you must just tick each location. This means that if you add a new location to Nookal you will need to find the existing API key in nookal settings and edit it to include the new location. 

Generating a Nookal API Key
  1. Go to Setup > Connections >  API Keys.
  2. Click Generate API Key.
  3. Select the appropriate Locations that this API Key will have access to.
  4. Toggle the Status switch to enable the API Key.
  5. Enter a descriptive Note about what app or service is using this key such as 'The BOS'.
  6. Click on the Save Changes button.
  7. Copy and paste the API Key into the appropriate field on the connecting app.
Removing a Nookal API Key
  1. Go to Setup > Connections >  API Keys.
  2. Toggle the Status switch for the appropriate API Key to Key Disabled.
  3. Click on the Save Changes button.

Nookal GraphQL "New API"

Nookal are rolling out a completely new API. Some data we collect from Nookal is only available via the new API so if you are missing some functionality (EG: case and payer information, ability to invoice appointments automatically) then you will need to enter a GraphQL key in addition to the 'old style' key. 

The process is:

  • Email support@nookal.com.au and ask for access to the GraphQL API
  • Once complete, go to BOS, Tenant Settings, Connections, Nookal and follow the instructions to generate a GraphQL API key then enter it. 

 

Back to top