Create API keys to integrate clariBI with your applications.
API Key Overview
What Are API Keys?
API keys enable programmatic access to:
- Generate reports automatically
- Refresh dashboards
- Query analytics data
- Manage data sources
Availability
API access requires Professional+ plan.
Creating API Keys
Step 1: Access API Keys
- Go to Settings > API Keys
- Or navigate to Developer Portal
- Click Generate New Key
Step 2: Configure Key
- Name: Descriptive identifier
- Permissions: Select allowed operations
- Expiration: Optional expiry date
Step 3: Set Permissions
Choose which operations the key can perform:
- `reports:read` - View reports
- `reports:generate` - Create reports
- `dashboards:read` - View dashboards
- `dashboards:refresh` - Refresh dashboard data
- `data_sources:read` - View data sources
- `usage:read` - Check credit usage
Step 4: Generate and Save
- Click Generate Key
- Copy immediately - shown only once
- Store securely
- Key is hashed in our database
Using API Keys
Authentication
Include in request header:
```
Authorization: Bearer claribi_your_api_key_here
```
Base URL
```
https://claribi.com/api/v1/
```
Example Request
```bash
curl -H "Authorization: Bearer claribi_abc123..." \
https://claribi.com/api/v1/dashboards/
```
Managing Keys
View Existing Keys
See all keys in the API Keys page:
- Name and prefix (claribi_xxx...)
- Permissions granted
- Created date
- Last used
- Usage count
Revoke a Key
- Find key in list
- Click Revoke
- Confirm revocation
- Key immediately invalid
Key Best Practices
- Create separate keys for different applications
- Use minimum required permissions
- Rotate keys periodically
- Revoke unused keys
- Never commit keys to version control
Rate Limits
Limits by Tier
| Tier | General/Hour | Generation/Hour |
|---|---|---|
| Professional | 1,000 | 100 |
| Enterprise | 5,000 | 500 |
Rate Limit Headers
Every response includes:
```
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 847
X-RateLimit-Reset: 1705142400
```
Developer Portal
Additional Resources
Access via Developer Portal:
- Interactive API documentation
- Code examples
- SDK downloads (coming soon)
- Webhook configuration
Testing API Calls
Use the built-in API tester:
1. Go to Developer Portal
2. Select endpoint
3. Enter parameters
4. Execute and see response