Authentication

You can generate API keys that can be added to the x-api-key header to authenticate API requests.

Generate an API key

1. Click on the drop-up menu with your name in the side panel.
2. Navigate to Settings > API Keys.
3. Click on the + ADD NEW button.
4. Enter a name for the key and click Yes.

Fig. 1: Generating an API key

5. Click on Copy And Close. Save the API key somewhere safe.

Fig. 2: Copy the API key

The API key cannot be viewed or copied after this step.

Performing API tests using the API key

Test the API in Zenskar documentation

1. Head over to the API documentation you would like to test.
2. Add the API key to the header as shown below:

Fig. 3: Preparing for an API test

3. Some APIs will require you to fill in the mandatory organization query parameter.

Fig. 4: The mandatory query parameter: organization

The organization query parameter can be obtained by navigating to Settings > General. The organization query parameter accepts a valid universally unique identifier (UUID).

Fig. 5: Obtaining the organization UUID

🚧

Note

If the mandatory organization query parameter is left empty or if a wrong UUID is entered, you may receive an HTTP 403 error with the following message in the response:

JSON

{  
   "Message": "User is not authorized to access this resource with an explicit deny"  
}

Fig. 6: HTTP 403 error response

4. Fill in the other necessary optional query parameters.
5. Click on Try It!. A successful test will result in an HTTP 200 status with a proper JSON response as shown below.

Fig.7: HTTP 200 success response

Test the API using tools like Postman

The API keys can be used to test the APIs using tools such as Postman or Thunder Client. You should refer to tool-specific instructions.

Deleting an API key

1. Click on the drop-up menu with your name in the side panel.
2. Navigate to Settings > API Keys.
3. Click on the button with the trashcan icon.

Fig. 8: Deleting an API key