API Endpoints
Roxom provides different base URLs for various environments and API types.
Production Environment
https://api.roxom.com/api
Sandbox Environment
Use the sandbox environment for testing and development. Sandbox API keys only work with sandbox endpoints.
API Versioning
All REST API endpoints are versioned. The current version is v1 and is included in the URL path:
https://api.roxom.com/api/v1/{endpoint}
SSL/TLS Requirements
All API communication must use HTTPS/WSS protocols. HTTP connections are not supported and will be rejected.
Configuration Examples
Environment Variables
# Production
ROXOM_API_BASE_URL=https://api.roxom.com
ROXOM_WS_BASE_URL=wss://api.roxom.com/ws
# Sandbox
ROXOM_API_BASE_URL=https://api.roxom.io
ROXOM_WS_BASE_URL=wss://api.roxom.io/ws
Python Configuration
import os
class RoxomConfig:
BASE_URL = os.getenv('ROXOM_API_BASE_URL', 'https://api.roxom.com')
WS_URL = os.getenv('ROXOM_WS_BASE_URL', 'wss://api.roxom.com/ws')
API_VERSION = 'v1'
@property
def rest_endpoint(self):
return f"{self.BASE_URL}/{self.API_VERSION}"
JavaScript Configuration
const config = {
baseUrl: process.env.ROXOM_API_BASE_URL || 'https://api.roxom.com',
wsUrl: process.env.ROXOM_WS_BASE_URL || 'wss://api.roxom.com/ws',
apiVersion: 'v1',
get restEndpoint() {
return `${this.baseUrl}/${this.apiVersion}`;
}
};
Ping
Before integrating, verify that the API is accessible:
curl -X GET "https://api.roxom.com/ping" \
-H "Content-Type: application/json"
Next Steps
