User Guide: Managing API Keys

What is an API Key?

An API key is a unique identifier used to authenticate requests made to an API (Application Programming Interface). It serves as a security measure to ensure that only authorized users or applications can access certain features or data. API keys are essential for integrating your applications with third-party services or products.

How Integration Helps

Integrating with APIs using API keys allows you to:

Access External Services: Utilize features and data from other applications, enhancing your own service's functionality.
Automate Processes: Streamline workflows by enabling automated interactions between systems.
Ensure Security: Control access to your resources by providing unique keys for different applications or users.

Accessing API Key Management

Navigate to Settings:

After logging in, locate the Settings icon (gear icon) in the main menu.
Click on Settings to open the settings options.

Select API Keys:

In the settings menu, find and select API Keys to access the API key management section.

Creating an API Key

Step 1: Create API Key

Click on Create API Key:
- In the API Keys section, click on the Create API Key button to start the process.

Step 2: Fill in API Key Details

Key Name:
- Field: Key Name
- Description: Enter a descriptive name for your API key to identify its purpose (e.g., "Integration with CRM").

Step 3: Generate the API Key

Generate:
- After entering the key name, click the Generate button to create your API key.
- The generated key will be displayed, and you should store it securely, as it will be required for making API requests.

Managing API Keys

Viewing and Using API Keys

List of API Keys: After generation, you will see a list of all your API keys, including their names and statuses.
Copying the API Key: Ensure you copy the generated API key and store it securely. You may need it for integration purposes.

Deleting an API Key

Delete: If you no longer need an API key, you can delete it from the list by clicking the Delete icon next to the key. Confirm the deletion when prompted.

Webhooks