- 27 Nov 2023
- 1 Minute To Read
- Print
- DarkLight
- PDF
Generate the API Token
- Updated On 27 Nov 2023
- 1 Minute To Read
- Print
- DarkLight
- PDF
An API key is a token that a client provides when making API calls. It is used for Authentication. This Integration Key must be included in the request header for all API calls.
The Whatfix web app uses a username and password for validating users. When using Whatfix APIs, API Key and API token are the equivalents of the username and password required to authenticate a user.
Whatfix needs your API token to validate each request. Each user in an enterprise has a different API token. The Whatfix system needs to know who you are connecting with and the actions they do with their account.
Generate the API Token
Once the API Token is enabled, use the following steps to generate the API key:
- On the Whatfix dashboard, at the top right, click the Settings icon.
- To generate the key, click API token.
- Once the API key is displayed use the Copy icon to copy it. Your title goes here
To secure this authentication method, the APIs are served only via HTTPS, and the key must be kept secret. Keys can be invalidated, and new keys can be generated to keep the keys secure.