Choose your workflow
Choose partner preorders for server-to-server catalog and preorder creation. Use external order ingress to deliver orders from another system. Guest interfaces use personal capabilities and contact verification instead of a restaurant-wide API key.
Prepare access
Ask the restaurant administrator to select the organization and venue in Hallify, enable the appropriate channel or provider connection, and grant only the required permissions. Credentials must be issued through the existing settings. Reading these pages does not create a credential.
Make the first request
The public server-to-server API base URL is https://api.hallify.co. The site’s /api proxy is application infrastructure, not a separate integration API. Configure only a test venue explicitly approved by its owner for your initial requests; this documentation does not provision a sandbox.
Open the first operation from your guide, read its prerequisites, copy cURL or TypeScript, and replace synthetic identifiers with values obtained from Hallify. Check HTTP status and the response body before advancing. Sample identifiers, tokens, dates and replies are illustrative, not live resources.
Continue reliably
Store keys on your server. Retain returned references, revisions and expiry timestamps. Reuse an idempotency key only for a retry of the same command. Handle expiration, conflicts and webhook replays according to the selected contract.