Getting Started
Authentication
Authenticate your API requests with an API key
All API requests require authentication via the x-api-key header. Include your API key with every request.
Obtaining an API Key
To obtain an API key, reach out to the Superbridge team.
API Key Best Practices
Your API key identifies your account and is used to track usage. If your key is compromised, contact us and we'll rotate it for you.
- Keep it server-side — don't expose your key in frontend code. If you need to call the API from a browser, route requests through your own backend.
- Use environment variables — avoid hardcoding keys in source code.
- Exclude from version control — add keys to
.gitignoreor use a secrets manager. - Limit access — only share with team members who need it.
Error Responses
Requests without a valid API key will receive a 401 Unauthorized response.