API Keys
All API requests require authentication using an API key passed in thex-api-key header.
Getting Your API Key
- Visit developers.webacy.co to sign up
- Generate your API key
- Copy and securely store your key
Troubleshooting API key creation
If you hit an error while creating a key on developers.webacy.co, try the steps below before contacting support.
If the issue continues after these steps, contact Webacy support with the exact error message and a timestamp.
Using Your API Key
Include your API key in thex-api-key header with every request:
Example Requests
Authentication Errors
Example Error Response
Best Practices
- Rotate keys periodically - Generate new keys and deprecate old ones on a regular schedule
- Use separate keys - Maintain different keys for development, staging, and production
- Monitor usage - Check the API Usage endpoint regularly
- Revoke compromised keys - If a key is exposed, revoke it immediately in your dashboard
- Server-side only - Never expose your API key in client-side code or mobile apps
