Servers (OpenAPI)
The published OpenAPI spec includes:| Server | Use case |
|---|---|
| Production | https://api.hofj.com — live traffic only for integrations you have approved. |
| Sandbox | https://sandbox.api.hofj.com — partner integration and QA. |
| Local | http://localhost:8080 — run npm run dev from the monorepo with apps/bff/.env pointed at your upstream CMS. |
BFF environment (local)
Copyapps/bff/.env.example to apps/bff/.env and set at minimum:
CONTENT_BASE_URL— content CMS base URL (no/apisuffix).- Offset / checkout routes (e.g.
v2-products):CONTENT_PRODUCTS_V2_RESOURCE,CONTENT_PAGINATION_STYLE=offset,CONTENT_CHECKOUT_HEADER=1,CONTENT_DEFAULT_CHANNEL_DOMAIN,CONTENT_DEFAULT_LOCALE, andCONTENT_TENANT_ROUTING_HEADERwhen your upstream uses a tenant header.
Versioning
- URL versioning:
/v1,/v2, … - Additive changes stay in the same major version; breaking changes require a new major path and a migration note.
CORS
If you call the API from a browser (web app or Mintlify Try it withplayground.proxy: false), the BFF must allow your docs/app origin via CORS (DOCS_SITE_URL / CORS_ALLOWED_ORIGINS). Server-to-server integrations do not use CORS.
