Authentication
Learn how to authenticate with the RankVectors API
API Keys
All API requests require authentication using an API key. You can generate API keys in your dashboard settings.
Getting Your API Key
- Navigate to Settings in your dashboard
- Go to API Keys section
- Click Generate New Key
- Copy and securely store your API key
⚠️
API keys are sensitive credentials. Never commit them to version control or share them publicly.
Using API Keys
Include your API key in the Authorization header of all requests:
Authorization: Bearer YOUR_API_KEY
Example Request
curl -X GET https://api.rankvectors.com/api/projects \
-H "Authorization: Bearer YOUR_API_KEY"
With JavaScript SDK
import { RankVectors } from '@rankvectors/rankvectors-javascript'
const client = new RankVectors({
apiKey: 'YOUR_API_KEY'
})
With Python SDK
from rankvectors import RankVectors
client = RankVectors(api_key="YOUR_API_KEY")
Key Permissions
API keys inherit the permissions of the user account that created them. Each key can:
- Read and write projects you own
- Generate suggestions
- Sync pages
- Access analytics
Key Security
- Rotate regularly: Generate new keys and revoke old ones periodically
- Use environment variables: Store keys in secure environment variables
- Limit access: Don't share keys with unauthorized parties
- Monitor usage: Check your dashboard for unusual activity
Rate Limits
API requests are rate-limited based on your subscription tier:
- Free: 100 requests/hour
- Pro: 1,000 requests/hour
- Enterprise: Custom limits
Rate limit headers are included in all responses:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1625097600