Important — API keys must be treated as secrets. Store them in environment variables or a secrets manager. Never commit keys to source code, client-side assets, or version control.
| Permission | Required For |
|---|---|
Upload Source | POST /search-federator/upload-source |
Upload Products | POST /search-federator/upload-products |
Domain Sources | Domain-scoped source listing and management |
List Products | GET /search-federator/products/{source_id} |
POST, PATCH, and DELETE operations.| Control | Description |
|---|---|
| SSL/TLS | HTTPS enforced at the network boundary via SSL certificate |
| Web Application Firewall (WAF) | Filters malformed, malicious, and out-of-policy requests before they reach the application |
| Rate Limiting | Prevents API abuse and protects service availability across all clients |
| Monitoring & Logging | Comprehensive logging of API usage supports anomaly detection, incident response, and audit |
| Layer | Mechanism | What It Protects Against |
|---|---|---|
| Authentication | API key / OAuth 2.0 over HTTPS | Credential interception, unauthenticated access |
| RBAC | Per-endpoint permission grants | Unauthorised operations by authenticated clients |
| Data Exposure | Endpoint and field restrictions | Data leakage, over-broad API responses |
| CSRF Protection | Token validation on write operations | Cross-site request forgery |
| Infrastructure | WAF, rate limiting, TLS, logging | Network attacks, abuse, undetected anomalies |