How to create an API key
APIs or Application Programming Interfaces can be used to integrate a wide range of external website features or third party applications with your CareHQ account. To allow an integration, an API key must be created.
A user with the account owner role can add API keys from the Account section of CareHQ.
How to add a new API key
To generate an API key, follow the steps below (you will need to be an account owner to create an API key).
- Select Account from the navigation.
- Select the API keys tab.
- Select the Add action.
-
Populate the Add API key form:
- Set a name for the key relevant to its purpose (e.g. Website enquiry form integration).
- The IP address(es) or IP range(s) (CIDR) you will call the API from.
-
Select the relevant permission you need for your integration; for a website integration this is commonly:
- Care enquiries > Create
- (Optional) Locations > Read
- (Optional) Groups > Read
- Select the Save button.
The option to disable signatures against an API key is provided for scenarios where requests cannot be signed; this is sometimes a restriction of the environment from where the API call is being made. We don't recommend disabling signatures, if you are considering doing so please speak to our support team first so we can advise you on whether this is necessary and any related risks.
You will then be shown your API key credentials, including:
- Account Id
- API key
- API secret
Copy these details and store them somewhere safe, as they are only displayed once.