Creating and Managing API Keys

API keys are your gateway to connecting HelpDocs with external applications and services. They provide secure, programmatic access to your Knowledge Base content and allow you to build powerful integrations.

Let's explore how to create and manage API keys.

What Are API Keys?

API keys are unique tokens that authenticate requests to the HelpDocs API. They act like digital keys that unlock specific parts of your Knowledge Base for external applications.

With API keys, you can:

• Search and retrieve articles programmatically
• Sync content with other platforms
• Power chatbots with your Knowledge Base content
• Build custom integrations for your workflow
• Export data for analysis or backup purposes

Creating Your First API Key

Getting started with API keys is straightforward. Here's how to create one:

1. Head to Settings > API
2. Click Create Key
3. A new API Key will appear at the bottom of the list with the current date and time as its name
4. Click More > Edit to view your key

Editing API Keys

Once you've created an API key, you can customize its settings to fit your specific needs:

1. Head to Settings > API
2. Find your key and click More > Edit

In the edit interface, you can modify:

• Key Name: Give your key a descriptive name like "Chatbot Integration" or "Data Export Tool"
• Permission Scope: Choose between Read-only or Read and Write access (Write access depends on your plan)
• Specific Permissions: Fine-tune exactly what your key can access within your Knowledge Base

Understanding Permission Scopes

• Read Access: Allows retrieving articles, categories, and other content. Perfect for search integrations and content syndication.
• Read and Write Access: Enables creating, updating, and deleting content through the API. Ideal for content management integrations and automated workflows.

Best Practices and Security Tips

Follow these guidelines to keep your API keys secure and effective:

• Use descriptive names: Name your keys based on their purpose, like "Slack Bot" or "Analytics Dashboard"
• Apply least privilege: Only grant the minimum permissions needed for each integration
• Rotate keys regularly: Create new keys periodically and deactivate old ones
• Keep them server-side: Never expose API keys in frontend code or browser applications
• Monitor usage: Regularly review your active keys and remove unused ones

Creative Ways to Use Your API Keys

Here are some ideas for putting your API keys to work:

Ready to start building? Check out our API documentation for detailed endpoints, examples, and implementation guides that'll help you make the most of your new API keys ✨