Authentication
Access to the RAX API requires authentication.
Authentication is used to control access, enforce rate limits, and associate usage with accounts or organizations.
API Keys
RAX uses API keys for authentication.
Each API key is associated with a specific user or organization and defines the scope of access and usage limits.
API keys should be kept confidential and stored securely.
Generating an API Key
API keys can be generated from the RAX dashboard.
Each key may be configured with:
A name or label
Access permissions
Usage limits
Keys can be rotated or revoked at any time.
Using API Keys
API keys must be included with each API request.
Keys are typically passed in request headers according to the API specification described in the Endpoints section.
Requests without valid authentication will be rejected.
Permissions and Scope
API keys may have different scopes, such as:
Read-only analytics access
Ranking and discovery access
Portfolio-level data access
Scope restrictions help enforce the principle of least privilege.
Rate Limiting
Authenticated requests are subject to rate limits.
Rate limits depend on:
Key type
Usage patterns
System load
Rate limit information is provided in API responses where applicable.
Security Best Practices
To protect API access, users should:
Avoid embedding API keys in client-side code
Rotate keys regularly
Revoke unused or compromised keys
Monitor usage patterns
Summary
Authentication ensures secure and controlled access to RAX APIs.
Proper key management is essential for reliable and secure integration.
Last updated