BrainPredict Commerce • Getting Started
BrainPredict Commerce Installation & Setup
10 min read•Last updated: January 2, 2025
Complete Installation & Setup Guide
This comprehensive guide covers everything you need to install and configure BrainPredict Commerce for your e-commerce platform.
System Requirements
- Server: Any server capable of making HTTPS requests
- PHP: 7.4+ (for PHP SDK)
- Node.js: 14+ (for JavaScript SDK)
- Python: 3.7+ (for Python SDK)
- Ruby: 2.7+ (for Ruby SDK)
- SSL Certificate: Required for production
Installation Methods
Method 1: Using SDK (Recommended)
The easiest way to integrate BrainPredict Commerce is using our official SDKs:
Python SDK
# Install via pip
pip install brainpredict-commerce-sdk
# Basic usage
from brainpredict-commerce import BrainPredict CommerceClient
client = BrainPredict CommerceClient(api_key='YOUR_API_KEY')
recommendations = client.personalization.get_recommendations(
user_id='user123',
context='homepage',
limit=10
)
JavaScript/Node.js SDK
// Install via npm
npm install brainpredict-commerce-sdk
// Basic usage
const BrainPredict Commerce = require('brainpredict-commerce-sdk');
const client = new BrainPredict Commerce({
apiKey: 'YOUR_API_KEY'
});
const recommendations = await client.personalization.getRecommendations({
userId: 'user123',
context: 'homepage',
limit: 10
});
Configuration
Store your API key securely using environment variables:
# .env file
BRAINPREDICT_COMMERCE_API_KEY=your_api_key_here
BRAINPREDICT_COMMERCE_API_URL=https://api.brainpredict.ai
BRAINPREDICT_COMMERCE_TIMEOUT=30
Testing Your Installation
Verify your installation is working correctly:
# Test API connection
curl -X GET https://api.brainpredict.ai/api/v1/health \
-H "Authorization: Bearer YOUR_API_KEY"
# Expected response:
{
"status": "healthy",
"version": "1.2.0",
"features": ["personalization", "social", "reviews", "seo"]
}