Skip to main content

How to Generate API Keys

Generate the API keys you need in order to make calls to the API

K
Written by Kay Chen

To make requests to the API, you need to set up an OAuth Bearer Token. This single string acts as the authentication of the API request, sent in an HTTP “Authorization” header. The string is meaningless to clients using it and may be of varying lengths, and needs to be regularly refreshed ("fetched").

There are two steps needed to generate a token:

  1. Generate API Access Token (a client ID and secret)

  2. Generate New API Access Keys or Get Existing Keys

🛑 Pro Tip - Tokens used for authentication, like a user's login credentials such as a username and password, are private and should not be shared with anyone else. The client secrets and keys that you generate for the API are linked to your account username, making them confidential. It is important to keep these tokens secure and not share them with anyone else.

Generate API Access Token

  1. Log into the Layar UI

  2. Click on the three vertical dots on the top left of the UI

  3. Click on "Generate API Access Token"

  4. In the Layar API Access popup, click on the "Generate API Access Keys" button

  5. Copy and Save the Client ID and Client Secret and save the information in a safe place.

API Keys

Generate New API Access Keys

  1. Log into your account page https://SERVER_HOST_NAME/account

  2. Click on User Profile

  3. Click on "Generate New API Access Keys"

  4. In the Generate API Keys popup, click on the "Generate Keys" button

  5. Copy the Client ID and Client Secret and keep it in a safe place.

Get Existing Keys

  1. Log into your account page https://SERVER_HOST_NAME/account

  2. Click on User Profile

  3. Click on "Get existing key"

Did this answer your question?