Authentication

Token-Based Authentication

The simplest approach to getting started with the Kizen API is token (API key) authentication.

Note: To follow industry best-practices, it is strongly recommended that a user is created in Kizen specifically for the purpose of integrating with the API. Additionally, a dedicated permission group and role should be created for this special API user. This way, the API access is limited in scope to what is enabled in the permission group, rather than being able to take any action on behalf of the user who created the token.

Creating an API Key

From the “My Profile” page, API keys can be created if the user has the required permissions. Existing tokens can also be managed from this page.

This token, along with the business ID and user ID, must be present in the header of API calls in order to successfully authenticate.

X-API-KEY
X-BUSINESS-ID
X-USER-ID

The user ID and business ID can be found on the “My Profile” page when viewing an existing API key.

These tokens may be deleted at any time from the “My Profile” page.

OAuth2 Authentication

OAuth2 is available as an additional authentication method. Please contact your Kizen support representative to learn more.