Understanding API Keys
API keys serve as your authentication credentials when making requests to Winnie’s services. Each key is associated with your account and plan, determining your rate limits and permissions.Protect your API keys like passwords. Never expose them in client-side code or public repositories.
Key Types
Standard API Key
General-purpose keys for accessing all services
Restricted API Key
Keys with limited permissions for specific services
Dedicated API Key
High-performance keys for dedicated nodes
Generating an API Key
1
Log in to your Winnie Dashboard
Visit dashboard.henlo-winnie.dev and sign in to your account
2
Navigate to API Keys section
Find the “API Keys” section in the dashboard menu
3
Generate a new key
Click the “Generate New Key” button and provide a name for your key
4
Set permissions (optional)
If creating a restricted key, select the specific permissions
5
Copy and store securely
Copy your new API key and store it securely - you won’t be able to view it again
Using API Keys
In the URL
Security Best Practices
Keep your API key confidential
Keep your API key confidential
Never expose your API keys in client-side code, public repositories, or insecure locations.
Rotate keys regularly
Rotate keys regularly
Periodically generate new API keys and deprecate old ones, especially for production environments.
Use environment variables
Use environment variables
Store API keys in environment variables rather than hardcoding them in your application.
Implement IP restrictions
Implement IP restrictions
Restrict API key usage to specific IP addresses for enhanced security.
Use the principle of least privilege
Use the principle of least privilege
Create keys with only the permissions they need for their specific use case.
Permissions
API keys can be configured with granular permissions:| Permission | Description |
|---|---|
rpc | Access to RPC endpoints |
webhooks | Ability to create and manage webhooks |
analytics | Access to analytics data |
admin | Administrative capabilities (use with caution) |
Monitoring and Analytics
Monitor your API key usage in the dashboard:- Track request volume and patterns
- View historical usage data
- Set up alerts for unusual activity
- Identify performance bottlenecks
Troubleshooting
API key not working
API key not working
Verify that you’re using the correct API key and that it hasn’t been revoked. Check for typos in the key string.
Receiving authentication errors
Receiving authentication errors
Ensure you’re sending the API key correctly in the URL.
Rate limit exceeded
Rate limit exceeded
Check your current plan’s rate limits. Consider upgrading your plan or implementing rate limiting on your side.