Skip to main content

Creating an API Key

To use Excelifier's API, you will first need to generate an API key. This key serves as a unique identifier for your organization and is necessary for authenticating and authorizing your API requests.

info

API keys are organization specific and you can have as many as you need.

How to Generate Your API Key​

Here's a simple guide to help you generate an API key within the Excelifier platform:

  1. Go to the API key page on the Excelifier dashboard.
  2. If you already have API keys, you'll see them listed here. To generate a new one, find and click on the "Generate a New Key" button located below the list of existing keys. If no keys have been created yet, you will be prompted to "Generate a New API Key."
  3. Upon generating the key, it is crucial to copy and store the key securely right away.
Important

Please copy and store the key safely as soon as it is generated. The key is displayed only once and cannot be retrieved again if lost.

API Key Details​

When viewing the list of your API keys on the dashboard, here are the details provided:

  • Used_at: Indicates the last time the API key was used, with the newest usage dates appearing first.
  • Name: The name you have assigned to your API Key for easy identification.
  • Created_at: The date and time when the API Key was generated.

Deleting an API Key​

Next to each API key in your list, you'll find a "Delete" button. If you no longer need an API key or if it has been compromised, you can easily delete it to prevent any unauthorized access to your account.

Authentication

To authenticate your API requests, include the generated API key as a Bearer token in the header of your HTTP requests. The correct format for including the API key in your request is as follows:

Authorization: Bearer <your_api_key_here>

This token is essential for securing your requests to Excelifier's API and ensuring that only authorized users can access your data and perform operations.