Authentication
The Scope3 Campaign API uses API keys for authentication. All requests must include a valid API key to access your campaigns, creatives, and other resources.Getting Your API Key
- Visit scope3.com/integrate/api-keys
- Sign up or log into your Scope3 account
- Generate a new API key for your integration
- Copy the key - it starts with
scope3_
Keep your API key secure! Don’t commit it to version control or share it publicly. Use environment variables or secure key management systems.
API Key Format
Scope3 API keys follow this format:scope3_abc123def456ghi789jkl012mno345pq_xyz789
MCP Authentication
For Model Context Protocol integrations with AI agents like Claude, OpenAI, or Anthropic: Python (Claude Code):Testing Authentication
Test your API key with thecheck_auth_status
MCP tool:
Security Model
Data Isolation
All API operations are automatically scoped to your Customer ID:- You can only access your own brand agents, campaigns, and creatives
- Multi-tenant security prevents cross-customer data access
- Agency accounts can manage multiple brand agents under one customer ID
Rate Limits
Resource | Limit | Notes |
---|---|---|
API Requests | 1,000/hour per key | Burst allowance available |
MCP Requests | 500/hour per key | AI agent usage |
Data Exports | 50/hour per key | Large report generation |
Best Practices
API Key Management
API Key Management
- Environment Variables: Never hardcode keys in source code
- Key Rotation: Rotate API keys every 90 days
- Least Privilege: Request only necessary permissions
- Monitoring: Track API key usage for anomalies
Error Handling
Error Handling
- 401 Unauthorized: Check if API key is valid and not expired
- 403 Forbidden: Verify you have permission for the requested resource
- 429 Too Many Requests: Implement exponential backoff retry logic
Production Setup
Production Setup
- HTTPS Only: All API calls must use HTTPS
- Secure Storage: Use secure key management (AWS Secrets Manager, Azure Key Vault, etc.)
- Logging: Log authentication failures for security monitoring
- Backup Keys: Keep backup API keys for continuity
Common Error Scenarios
Invalid API Key
Missing Authentication
Rate Limit Exceeded
resetTime
or implement exponential backoff.