How to manage API keys

Modified on Tue, 23 Jan 2024 at 03:48 PM

If you need to access our API to manage your records, you need a personal API Key

Before you create your first key

Be aware that an API key provides a complete and unlimited access to your account data (considered as "SuperAdmin"), so when you create an API Key, keep it secret and don't share it unless to your developer(s)

At any time, for security reason, you can revoke any token. If you work will multiple environments (ex: DevelopmentProduction), we invite you to create multiple tokens.

How to create your first API key

- Log into CheckHub Admin using your personal credentials

- Go to SettingsAPI Tokens
(You need Administrator or Company Settings right)

- Click on New Token and add a Token Name (ex: Local, DEV, PROD). Use something to help you remember where this token is used

- Once your new key is created, simply Copy to start using it

How to revoke an API Key

If you need to revoke an API key, simply click on Revoke and Confirm your action. Once deleted, you cannot reuse this token 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article