Note:
Whatfix API access is a prerequisite for sending requests to the Whatfix APIs. To enable Whatfix API access, contact support@whatfix.com.
The Whatfix Application Programming Interface (API) enables you to perform the same operations that are available on the Whatfix web client. Use the Whatfix APIs to access and work with Whatfix data programmatically, without using the Whatfix Dashboard.
For example, you can use the Whatfix APIs to bring Whatfix data into your own data warehouse or Business Intelligence (BI) tool and build reports on top of it.
How the Whatfix API Works
The Whatfix APIs follow a small set of web standards, so most Hypertext Transfer Protocol (HTTP) clients and programming languages can call them. The Whatfix APIs work in the following ways:
REST principles: Each request acts on a resource, such as an account or its data, using a standard HTTP method.
HTTP rules: Requests and responses follow standard HTTP, so any HTTP client can interact with the Whatfix APIs.
Unique resource URLs: Whatfix exposes every resource as a unique URL, which you can get from the API Root Endpoint.
HTTPS only: Whatfix serves the APIs only over Hypertext Transfer Protocol Secure (HTTPS), which protects your API Token and your data in transit.
Authentication
Whatfix validates every API request with an API token. Ensure you include your API token in the request header of each API call.
Each Whatfix Dashboard user receives their own API token. The API token identifies the user who makes each request and determines which actions that user can perform on the account.
For more information, see Generate an API Token.
API Token Security
Keep your API token confidential to prevent unauthorized access to your Whatfix account. Use the following practices to keep your API token secure:
Store the API token in a secrets manager or an environment variable. Do not store the token in source code.
Share the API token only with the developers who build the integration, using a secure channel.
Renew the API token if it is exposed, and then update every integration that uses it.
Info:
Whatfix enables you to invalidate and regenerate API tokens to keep them secure. To generate a new API token, click Renew User API Token. For more information, see Generate an API Token.
For more information, see API Documentation.