API & Integrations
A versioned, well-documented integration surface.
Operators integrate with RegulaView through a single authenticated API at api.regulaview.io. The same interface supports streaming ingestion, batch submission and queryable read-models.
Authentication
OAuth 2.0 client credentials for operator-to-platform integration. Bearer JWTs for admin sessions. Scoped tokens with explicit privileges.
Versioning
URI-based major versioning (/v1/...) with additive changes inside a version. Deprecations announced ahead of removal.
Idempotency
Submission endpoints accept an Idempotency-Key header. Duplicate submissions are recognized and de-duplicated.
Pagination & filtering
Cursor-friendly paging on read endpoints with consistent page/pageSize contracts and total counts.
Validation & errors
RFC 7807 problem responses with stable error codes, correlation IDs and human-readable detail.
Observability
Every request carries a correlation ID returned in X-Correlation-Id for traceability across the platform.
Integration paths
- Streaming ingestion — recommended for high-volume operators; events flow continuously through signed, authenticated channels.
- Batch submission — supported for operators with batch-oriented systems, with transparent fan-out and replay.
- Read APIs — operator-scoped queries for transactions, devices, alerts and reconciliation positions.
- Webhooks — for ack, validation outcomes and incident notifications (planned).
Full OpenAPI documentation is available to authorized integration partners.