Authorization header.
API Keys
Send your API key using the Bearer authentication scheme:Getting Your API Key
- Sign up at signa.so/dashboard
- Navigate to the API Keys section
- Click “Generate New API Key”
- Copy and store it securely
tm_live_abc123xyz...
Example Requests
Key Management
Environment Variables
Store your API key as an environment variable:Multiple Environments
Create separate keys for different environments:- Development:
tm_test_... - Staging:
tm_test_... - Production:
tm_live_...
Key Rotation
Rotate keys regularly for security:- Generate a new key in the dashboard
- Update your application with the new key
- Test the new key works
- Revoke the old key
- Use both old and new keys temporarily
- Gradually migrate to the new key
- Revoke the old key once fully migrated
Revoking Keys
Immediately revoke a key if:- It’s been exposed publicly
- An employee with access leaves
- You suspect unauthorized access
401 Unauthorized immediately.
API Key Scopes
Keys can have different permission scopes:| Scope | Description | Use Case |
|---|---|---|
| Full Access | All API operations | Production applications |
| Read Only | Search and lookup only | Analytics dashboards |
| Limited | Specific endpoints only | Third-party integrations |
Error Responses
Missing API Key
Invalid API Key
Expired API Key
Revoked API Key
Best Practices
Use Environment Variables
Use Environment Variables
Never hardcode API keys in your source code:
Implement Key Validation
Implement Key Validation
Validate API keys before making requests:
Handle Auth Errors Gracefully
Handle Auth Errors Gracefully
Provide clear error messages for authentication failures:
Monitor Key Usage
Monitor Key Usage
Track which keys are used where:View key usage analytics in your dashboard.
Security Recommendations
Client-Side vs Server-Side
Server-Side (Recommended)
API keys should be used server-side:Client-Side (Not Recommended)
Don’t expose API keys in browser JavaScript:Webhook Authentication
For webhooks, we sign requests with your webhook secret:FAQ
Can I use the same API key in multiple applications?
Can I use the same API key in multiple applications?
Yes, but we recommend using separate keys for each application. This makes it easier to track usage and rotate keys without affecting other apps.
Do API keys expire?
Do API keys expire?
Keys don’t expire automatically, but you can set expiration dates in the dashboard. We recommend rotating keys every 90 days.
What happens if my API key is exposed?
What happens if my API key is exposed?
Immediately revoke it in the dashboard and generate a new one. Monitor your usage to check for unauthorized access.
Can I regenerate the same API key?
Can I regenerate the same API key?
No. Once revoked, a key cannot be recovered. You must generate a new key.
How many API keys can I have?
How many API keys can I have?
Unlimited. Create as many keys as needed for different applications and environments.