API access keys are unique codes that act like passwords, allowing authorized applications and users to securely interact with Sona's API. This guide will walk you through creating, managing, and deleting access keys in your Workspace Settings. With this guide, you'll be ready to confidently generate and manage keys for different integrations, ensuring secure and organized API access across your team.
When to Use This
When to Use This
Use API access keys when you need to:
Connect Sona with external tools and platforms
Set up integrations for dashboards, CRM systems, or marketing automation
Provide API access to different team members or applications
Organize and track API usage by purpose (e.g., separate keys for development vs. production)
Prerequisites:
Admin access to Workspace Settings
Understanding of which integration or application needs API access
Step-by-Step Instructions
Step-by-Step Instructions
Step 1: Creating a New Access Key
Step 1: Creating a New Access Key
Navigate to Access Key Settings
From the left sidebar, click on Workspace Settings
Select Access Key from the menu
Initiate API Key Creation
Click the + Create New button in the top-right corner
A modal will appear "Create new API Access Key"
Name Your Access Key
In the Key Name field, enter a descriptive name that identifies the key's purpose
Examples: "Account Enrichment API Key," "CRM Integration Secret," or "Marketing Automation Key"
Choose names that clearly indicate what the key is used for—this makes management easier later
Generate the Key
Click the Confirm button
Your new access key will be generated and added to the list
Important: Copy your access key immediately after creation. For security reasons, you won't be able to view the full key again
Save Your Key Securely
Store the key in a secure location (password manager or secure vault)
You're almost there! Your API access is now set up and ready to use.
Step 2: Viewing and Managing Existing Keys
Step 2: Viewing and Managing Existing Keys
The Access Keys page displays all of your current keys in a table format with the following information:
Key: The unique identifier (truncated for security)
Name: The descriptive name you assigned
Created at: Date and time of creation
Step 3: Deleting an Access Key
Step 3: Deleting an Access Key
Locate the Key to Delete
Find the access key you want to remove in the table
Click the trash icon (🗑️) on the right side of the row
Confirm Deletion
A confirmation dialog will appear asking: "Are you sure you want to delete the '[Key Name]'?"
Click Confirm to permanently delete the key
Click Cancel if you want to keep it
This step brings everything together—you now have full control over your API access management!
Key Concepts/Best Practices
Key Concepts/Best Practices
Organization & Security:
Create separate access keys for different purposes (e.g. data enrichment, analytics, etc.)
Use descriptive, meaningful names that clearly identify each key's purpose
Regularly audit your access keys and delete unused ones
Never commit access keys to code repositories or share them publicly
Key Management:
Document which applications or team members are using each key
Rotate keys periodically for enhanced security
If you suspect a key has been compromised, delete it immediately and create a new one
Keep a secure backup of active keys in your organization's password management system