Skip to main content

Generating a Nookal API key

Learn how to generate a v3.0 API key within Nookal, to connect Finger-Ink to your Nookal account.

Brendan Kilfoil avatar
Written by Brendan Kilfoil
Updated over a week ago

API stands for "Application Programming Interface". It's what lets Finger-Ink talk to Nookal. There are two parts to this talking:

  1. Identification and authentication

  2. The chatter itself — allowing us to do things like get your appointments and check patients in

The API key

Before we can get to the chatter itself, we need to identify & authenticate your account. This step requires an API key. This key is like a password that you can generate from your Nookal account, specifically for this type of access.

Two versions of the API

Nookal has two APIs. Their old API, and their new (v3.0) API. Finger-Ink exclusively uses the new, v3.0 API. This means Finger-Ink will not work with old API keys, it needs a v3.0 API key with the correct permissions.

Generating an API key

To generate an API key, you'll need to sign into your Nookal account, then navigate to the Setup page, then expand the connections menu and click on API v3.0, before finally clicking the "Create New Client" button:

☝️ If you don't have an API v3.0 option, please contact Nookal support to get them to enable it for your account.

Configuring the client

Finger-Ink only needs a limited set of permissions within your Nookal account. And it's always best to restrict any integration to only those permissions necessary — to avoid unnecessary risk.

Here's how you should configure the client:

Please note

  1. ⭐️ The "Basic Key" is only shown once, when you're on this screen, so be sure to copy it before you save!

  2. The "Client note" lets you find the key later on within Nookal — and if you name it "Finger-Ink" then you'll know exactly what you're using it for.

  3. You should fill in "Locations" with all your available locations.

  4. The "Queries" and "Mutations" need at least the exact permissions as shown in the screenshot above.

Once you've got that key, just paste it into the API key box in the Finger-Ink start trial page, fill out the rest of the deatils, and you're done!

Did this answer your question?