Authentication
Understand how to securely authenticate your requests using API keys, including key management and security considerations.
API Key Setup
Copy Your API Key
Copy the generated API key. You'll only see it once, so make sure to save it securely.
ps_live_1234567890abcdef...
Use in Your Requests
Include your API key in the Authorization header of all API requests.
Authorization: Bearer ps_live_1234567890abcdef...
Security Best Practices
Never expose API keys in client-side code, public repositories, or logs. Store them securely in environment variables.
Rotate your API keys regularly and use different keys for different environments (development, staging, production).
Monitor your API usage to detect unusual activity and ensure you stay within rate limits.
Always use HTTPS when making API requests to ensure your API keys are transmitted securely.
Rate Limiting
Our API uses rate limiting to ensure fair usage and maintain service quality. Here are the current limits:
Free Plan
1,000
requests/hour
Starter Plan
10,000
requests/hour
Business Plan
100,000
requests/hour
Error Handling
{
"error": "Invalid or expired API key",
"status": 401
}
{
"error": "Rate limit exceeded",
"status": 429,
"retry_after": 60
}
{
"error": "Internal server error",
"status": 500
}