Skip to content

API Key Management

API keys are essential for authenticating and authorizing API access within the platform. This section explains how users can generate their personal API keys and the security measures in place to ensure safe API interactions.

Generating an API Key

To generate a new API key, follow these steps:

  1. Access API Key Settings:

    • Click on your username at the top right corner of the page.
    • Select API Key from the dropdown menu to navigate to the API Key page.

  2. Generate New API Key:

    • On the API Key page, click the Generate API Key button.
    • A new API key will be generated, and any previously existing API key will become invalid.

API Key Generation

Security Measures

  • Key Generation: API keys are generated following stringent security standards that include randomness criteria and cryptographic hashing. This ensures that the keys are secure and robust against potential attacks.
  • Key Storage and Verification: Generated keys are stored as hashes. When an API key is used for access, it is rehashed and verified against the stored hash to confirm its authenticity. This process ensures that the actual key values remain hidden and secure.

Using Your API Key

Once generated, the API key can be used for API access or within different clients provided by the platform. Ensure that you store your API key in a secure location and never share it publicly to prevent unauthorized access.

For detailed instructions on integrating API keys with specific APIs or clients, refer to the corresponding sections of this documentation or the API integration guide.