Authentication
The RotaStellar API uses API keys for authentication. All requests must include a valid API key.Getting an API Key
1
Request Access
Sign up for early access to receive your API credentials.
2
Receive Credentials
You’ll receive an email with your API key (starts with
rs_).3
Store Securely
Store your API key securely. Never commit it to version control.
Using Your API Key
Include your API key in theAuthorization header with the Bearer prefix:
Example Request
API Key Types
| Type | Prefix | Use Case |
|---|---|---|
| Live | rs_live_ | Production applications |
| Test | rs_test_ | Development and testing |
Security Best Practices
Never expose keys in client-side code
Never expose keys in client-side code
API keys should only be used in server-side code. Never include them in
JavaScript bundles, mobile apps, or anywhere users can inspect.
Use environment variables
Use environment variables
Store API keys in environment variables, not in code:
Rotate keys periodically
Rotate keys periodically
Rotate your API keys periodically and immediately if you suspect compromise.
Use separate keys per environment
Use separate keys per environment
Use different API keys for development, staging, and production.
Revoking Keys
If your API key is compromised:- Go to your dashboard
- Navigate to API Keys
- Click “Revoke” on the compromised key
- Generate a new key
- Update your applications
Errors
| Code | Description |
|---|---|
401 | Invalid or missing API key |
403 | API key doesn’t have permission for this endpoint |
429 | Rate limit exceeded |