API Key Management

Generate and manage API keys for different sources and integrations.

Overview

API keys allow secure authentication between your systems and the Batch platform. Learn how to generate, manage, and secure your API credentials.

API Key Types

Admin API Keys

Full access keys for:

• Platform administration
• Backend integrations
• Server-to-server communication

Customer API Keys

Limited access keys for:

• Customer-facing applications
• Mobile apps
• Web portals

Integration-Specific Keys

Specialized keys for:

• POS systems
• E-commerce platforms
• Third-party integrations

Creating API Keys

1. Generate New Key

Steps to create a new API key:

1. Navigate to Settings > API Keys
2. Click "Generate New Key"
3. Select key type and permissions
4. Add description/label
5. Copy and securely store the key

2. Configure Permissions

Set appropriate scopes:

• Read/Write access
• Resource-specific permissions
• Rate limits

3. Assign to Sources

Link keys to specific:

• Applications
• Integrations
• Environments (dev, staging, production)

Security Best Practices

• Never expose API keys in client-side code
• Rotate keys regularly
• Use environment variables for key storage
• Implement separate keys for different environments
• Monitor key usage and access logs

Managing Existing Keys

Viewing Keys

• List all active keys
• View key metadata and usage
• Check last used date

Rotating Keys

• Generate replacement key
• Update applications
• Revoke old key

Revoking Keys

Immediately revoke compromised or unused keys.

Next Steps

• Integration Overview

Related Resources