Guides
The rules of the road: authentication, pagination, errors, rate limits, versioning and environments.
Guides
The rules of the road: authentication, pagination, errors, rate limits, versioning and environments.
API Reference
One page per resource, from properties and room types to reservations, folios and invoices.
Webhooks
The inbound Holded webhook keeps invoice statuses in step (live since Stage 2); outbound platform events are planned.
Changelog
Every notable change to the API and the platform, in one place.
Hostal Don Pepe is a small hostal in Figueres (Girona, Spain). This platform replaces phone/email bookings and manual extranet work with a purpose-built stack:
The API documented here is the single backend shared by the admin app, the public website and future channel integrations.
The API is live through Stage 3: staff auth + RBAC, inventory, guests, reservations and the availability engine (Stage 1); folios, payments and Holded invoicing (Stage 2); the public direct-booking engine, settings, promo codes, the guest CRM, tourist tax, deposits and housekeeping (Stage 3) — see the changelog. These docs describe the contract as implemented, modeled on the conventions of Mews and Cloudbeds (see design inspirations). Operations that are not wired yet are explicitly marked Planned; nothing here claims live behavior that does not exist.
These docs live in the portal/ directory of the monorepo. Two sibling
locations matter when reading them:
docs/adr/ — architecture decision records. Where a guide states a policy
(versioning, error format, auth model), the why is recorded there.openspec/ — spec-driven change proposals (OpenSpec workflow). New API
surface lands there first, then in the API, then in these docs.