Xaroxa API

Integration reference

Gateway documentation

A compact reference for route structure, health semantics and response envelopes. Access to versioned API routes may require authorization.

Quickstart

The gateway exposes a small public surface for availability checks and operational reference pages. Versioned API namespaces are restricted by default.

GET /health.json HTTP/2
Host: api.xaroxa.ru
Accept: application/json

Health response

The health endpoint returns a simple readiness payload for service checks.

{
  "service": "xaroxa-api",
  "status": "ok",
  "region": "eu",
  "version": "2026.04"
}

Response envelope

Successful JSON responses use a stable envelope with operation metadata and result payload.

{
  "operation_id": "op_01JX9R7V6Y6A",
  "state": "accepted",
  "data": {},
  "meta": {
    "region": "eu",
    "api_version": "2026-04"
  }
}

Error model

Restricted namespaces return structured errors. This keeps monitoring and client handling predictable.

{
  "error": {
    "code": "unauthorized",
    "message": "API token required"
  }
}

Versioning

Versioned routes live under /v1/. Breaking changes are introduced under a new version prefix. Health and status routes remain unversioned.