Skip to main content

Integration API: schema versioning + platform endpoints on staging

The Integration API gains schema-versioning tools and a set of platform endpoints on the staging sandbox. These were previously on the roadmap; they reach production at the Phase 1.5 release.

Availability

The endpoints below are live on the staging sandbox (staging.traceable.digital), not yet on production. See the Availability matrix.

Schema versioning​

  • GET /api/v1/categories/{code}/diff — compare two versions of a category schema (added, removed, and changed fields), so an integration can see what changed before adopting a new version.
  • GET /api/v1/products/{id}/schema-compatibility — check whether a product's authored data still matches the current schema, and whether it must migrate.

Platform endpoints​

  • GET /api/v1/openapi.json — the live, machine-readable OpenAPI contract, generated from the running application. Unauthenticated.
  • GET /api/v1/meta — introspect the calling key: its granted scopes, the full scope vocabulary, and the rate-limit policy. Requires a valid key but no specific scope.
  • GET /api/v1/health — an unauthenticated liveness probe that is not gated by the products feature flag.

Response headers​

Every response now carries x-traceable-api-version and x-traceable-request-id. Authenticated responses also carry RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset, and a 429 adds Retry-After.

Read more​