API Keys

Provides a simple and straightforward way to authenticate by including your unique key in each request. This method is ideal for server-to-server communication or lightweight integrations.

1. Creating an API Key

Pre-requisites

You must have "admin" permission in the Zylo application.

In the Admin page within the Zylo application, find the "Company Tokens" tab.

Select the "Request Token" button to open up the "Create Token" modal.

Fill out the fields and click "Save" to generate your token_id and token_secret.

📘
Important Note
Your token_secret can only be viewed once. Be sure to copy it and save it into a secure place.

After creating the token, you can edit it at any time to update your permissions.

2. Using the API Key

The API Key consists of two parts: the token_id (UUID) and the token_secret (64-character alphanumeric string). The two are combined, separated by a colon, to create an API Key to be used as a bearer token (Authorization: Bearer {token_id}:{token_secret}).

The bearer token is included in the Authorization request header for all authenticated API resources.

Below is an example using the token_id and token_secret as an API Key in a request:

curl --request GET \
  --url https://api.zylo.com/v2/applications \
  --header 'Authorization: Bearer {token_id}:{token_secret}' \
  --header 'Content-Type: application/json'