HPOS 2 API
Search…⌘K

↑↓select↵openescclose

Get started

Quick start

Check the key, register a webhook, send a first order.

  1. Get the base URL and API key from the restaurant. The till shows both once, when the connection is created.
  2. Check the key:
    Bash
    curl https://management.horeca-24.de/api/partner/v1/ping \
  -H "Authorization: Bearer pk_pc_3f1c…"
  3. Register your webhook URL and store the webhookSecret from the answer. It is shown only this once.
    Bash
    curl -X PUT https://management.horeca-24.de/api/partner/v1/webhook \
  -H "Authorization: Bearer pk_pc_3f1c…" -H "Content-Type: application/json" \
  -d '{"url":"https://partner.example/hooks/horeca24"}'
  4. If the restaurant has synced its menu, you receive menu.updated right away. Download the file from its url.
  5. Send an order with POST /orders (see §8.1). It rings in the till under the connection's name.
  6. Handle the order.* events the restaurant's actions produce.