Overview
Pixel Patrol can be integrated into any application through our REST API. This guide covers installation options, authentication setup, and basic configuration.
Integration Methods
REST API
The primary integration method for all platforms:
SDKs (Coming Soon)
Official SDKs in development:
JavaScript/TypeScript
Python
PHP
Ruby
Go
Java
Authentication Setup
Getting Your Site Key
Sign up at pixelpatrol.net
Create your team
Create a site
Copy the site key from site settings
Storing Site Keys
Never expose site keys in client-side code or public repositories
Best practices for site key storage:
Environment Variables
Secrets Manager
Key Vault
Basic Configuration
Initialize Client
Create a reusable client configuration:
Framework Integration
Next.js
Express.js
Django
Error Handling
Common Errors
Implement proper error handling:
Retry Logic
Implement exponential backoff:
Testing
Test Environment
Use test mode for development:
Mock Responses
For unit testing:
Next Steps
After installation:
Configure your first site
Set up moderation rules
Implement webhooks
Test the integration
Support
Need help with installation?