ClickHelp Documentation

API: Authentication

ClickHelp User Manual/ClickHelp API/API: Authentication

In all API calls, you need to authenticate yourself by specifying a user login and the API Key of that user. This ensures only authorized users can make API calls to your documentation portal.

The majority of the API calls require authentication. Only Authors with the administrator role can make API calls since all other user types/roles can not generate API keys. 

Generating an API Key

API keys are user-specific. To generate your own API key, do the following:

  1. Login to your documentation portal.
  2. Click your profile picture in the top-right corner and select My Profile from the dropdown menu.
  3. On your profile page, click the Reset API Key button:
    The Reset API key button in the user's profile 
  4. Check your Inbox - you will receive your API key via e-mail.

Once you receive your API key, you can authenticate your API calls as described below.

For security reasons, the API Key is not stored anywhere in your ClickHelp portal. It is sent to the user's e-mail address after generation.
If your API Key is lost or compromised, generate a new key. Only the latest generated API Key can be used for authentication.

API Calls Authentication

ClickHelp uses the Basic HTTP Authentication mechanism. The idea is simple - every API call must have a special authentication header, which is generated on the client side based on the user login and the user's API Key. This mechanism is supported by all major tools and utilities that can be used to make REST API calls.

When authenticating, you need to supply your login and the API key, not your password.

To learn more on Basic Authentication, refer to this Wikipedia article:  Basic access authentication

If there was an authentication issue when processing any API call, the server responds with the 401 status code. The response body may contain additional information on what went wrong. To learn more on errors, see the Error Handling topic.