API Keys
API keys provide a secure way to authenticate your requests to our API. This guide will walk you through the process of generating, managing, and using API keys in your application.
Generating an API Key
To generate an API key:
- Log in to your account
- Navigate to the Account Settings page
- Scroll to the "API Key Management" section
- Click the "Generate API Key" button
- Copy the displayed API key immediately, as it won't be shown again
Managing API Keys
You can manage your API keys from the Account Settings page:
- View your current API key (partially masked for security)
- Revoke your current API key
- Generate a new API key (this will invalidate the previous key)
Using API Keys
To use your API key, include it in the Authorization
header of your HTTP requests:
Authorization: Bearer YOUR_API_KEY
Example using cURL:
curl -H "Authorization: Bearer YOUR_API_KEY" https://www.contentflywheel.com/api/v1/[endpoint]
Example using JavaScript (fetch):
fetch('https://www.contentflywheel.com/api/v1/[endpoint]', { headers: { 'Authorization': `Bearer YOUR_API_KEY` } }) .then(response => response.json()) .then(data => console.log(data));
Security Considerations
- Keep your API key secret and secure
- Don't share your API key in publicly accessible areas such as GitHub or client-side code
- If you suspect your API key has been compromised, revoke it immediately and generate a new one
- API keys are subject to rate limiting to prevent abuse
API Key Expiration
API keys automatically expire after 30 days for security reasons. You'll need to generate a new key after expiration.
Rate Limiting
API requests using API keys are subject to rate limiting. The current limit is 100 requests per minute. If you exceed this limit, you'll receive a 429 (Too Many Requests) response.
For any questions or issues related to API keys, please contact our support team.