Guides

Concept guides for integrating with the Hapana API. The endpoint reference covers what each call returns; these guides cover the rules of the road.

Firebase ID tokens for the Member API — how members sign in and call the API.

Adding payment methods via the Stripe embed, connecting your own Stripe account, and testing.

Per-member and endpoint limits, response headers, and retry guidance.

For door and access-control systems: cache who may check in, list your doors, pre-load bookings, and ask Hapana on every tap.

For scheduling and workforce partners: scopes, substitutions, and syncing with updatedSince.

Error code taxonomy, retry classes, and the standard error envelope.

Getting a brand key, what each scope allows, rate-limit headers and idempotency.

Real-time events pushed to your server: setup in Core, locations, envelope, headers, and retries.

Check the HMAC-SHA256 signature on every delivery, with Node, Python, Ruby, Go and PHP.

Every event type with its fields and an example payload, plus the legacy v1 check-in.

Mirror members locally, keep the mirror current with webhooks, and decide entry at the reader.