Downloads

Postman collection

The v2.1 collection is versioned in the repository:

Path: packages/contracts/postman/HoJ-Distribution-API.postman_collection.json

Import in Postman: File → Import → Upload file (or paste raw JSON). Variables (collection variables):

Variable	Typical value
`baseUrl`	`http://localhost:8080` or your staging base URL
`apiKey`	Your API key (dev: see README)
`accessToken`	Filled by the OAuth request’s test script
`brand`	e.g. `Weebora`
`locale`	e.g. `it`

Folders include health, auth, distribution channels, products, and content entities (categories, destinations, venues, pages, articles).

Location	Notes
Repo: `packages/contracts/openapi/hoj-distribution-v1.openapi.json`	Source of truth; review in PRs.
Docs site copy: `developer-docs/openapi/hoj-distribution-v1.openapi.json`	Synced with `npm run docs:sync-openapi` for Mintlify.
Live: `GET /v1/openapi.json` on a running BFF	Same contract as deployed.

Use OpenAPI for codegen, contract tests, and API gateways (e.g. Apigee).

If you need a stable URL for tools that pull OpenAPI by URL:

https://gitlab.com/house-of-journeys/api/-/raw/main/packages/contracts/openapi/hoj-distribution-v1.openapi.json

Pin to a tag or commit SHA for reproducible builds.