Skip to main content

Base URL

The examples use an illustrative URL:
Replace it with the URL assigned to the appropriate environment. Do not mix identifiers or credentials between testing and production.

Headers

All protected routes require:
The API key must remain exclusively in backend infrastructure. Rotate it if it appears in a repository, browser, screenshot, or uncontrolled log.

Request correlation

Every response includes X-Request-ID. If an error occurs, store this value together with the UTC time, method, path, and HTTP code. You may send your own X-Request-ID to preserve traceability across systems.

Environment documentation

When enabled by the operator: These interfaces reflect the complete technical schema of the service. For an external integration, treat the subset published in this portal as authoritative.

Continue

Previous: Integration model

Return to the scope and separation of responsibilities.

Next: End-to-end integration

Apply the previous concepts in the complete sequence for connecting a leader and follower.
Last modified on August 24, 2026