Authentication
The BringRings API uses API keys to authenticate requests.
Getting Your API Key
- Log in to your BringRings Dashboard
- Navigate to Settings → API Keys
- Click Generate New Key
- Copy and securely store your key (it's only shown once!)
Important: Your API key is only displayed once upon creation. If you lose it, you'll need to regenerate a new key.
Using Your API Key
Include your API key in all requests using the x-api-key header:
Terminal
curl https://api.bringrings.com/api-keys/whoami \ -H "x-api-key: pk_live_xxxxxxxxxxxxxxxx"Response:
{ "success": true, "teamId": "team_abc123", "keyName": "Production API Key"}Key Format
BringRings API keys follow this format:
pk_live_xxxxxxxx...xxxx
- pk_live_ — Prefix indicating a production key
- xxxxxxxx — 8-character lookup prefix
- xxxx — Last 4 characters (shown in dashboard)
Security Best Practices
✓ Do
- • Store keys in environment variables
- • Use different keys for development and production
- • Rotate keys periodically
- • Revoke keys immediately if compromised
✗ Don't
- • Expose keys in client-side JavaScript
- • Commit keys to version control
- • Share keys via email or chat
- • Use the same key across all environments
Rate Limits
API key generation is rate limited to prevent abuse:
| Operation | Limit |
|---|---|
| Key generation/regeneration | 10 per hour |
| API requests | 100 per minute |