BookNDish API

Bauen Sie auf BookNDish auf

Eine dokumentierte REST API, signierte Webhooks und eine kostenlose Sandbox. Verbinden Sie eine Website, ein Küchendisplay, ein CRM oder ein Buchhaltungstool mit jedem Restaurant auf BookNDish, mit Erlaubnis des Inhabers.

Token erstellen OpenAPI (YAML)OpenAPI (JSON)

Die untenstehende API-Referenz ist auf Englisch verfasst.

Schnellstart

01
Token holen
Der Inhaber oder ein Manager des Restaurants öffnet Einstellungen, dann Entwickler, und erstellt einen Token mit den Berechtigungen, die Ihre Integration braucht, oder einen Sandbox-Token, um mit Beispieldaten zu starten. Ein Token gehört zu genau einem Restaurant und wird nur einmal angezeigt.
02
API aufrufen
Senden Sie den Token als Bearer-Token. Jede Antwort ist JSON mit data, meta und links.
03
Sicher schreiben
Geben Sie jedem POST einen Idempotency-Key. Eine Wiederholung mit demselben Schlüssel erhält die erste Antwort zurück, und nichts wird doppelt ausgeführt.

Basis-URL: https://restaurant-saas-19qm.onrender.com/api/v1

curl https://restaurant-saas-19qm.onrender.com/api/v1/menus \
  -H "Authorization: Bearer $BOOKNDISH_TOKEN" \
  -H "Accept: application/json"

curl -X POST https://restaurant-saas-19qm.onrender.com/api/v1/orders \
  -H "Authorization: Bearer $BOOKNDISH_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5b0e1f4e-6a8c-4e0e-9a55-0c1f2d3e4f5a" \
  -d '{"type":"pickup","customer_name":"Ada","customer_phone":"+15550100","lines":[{"item_id":42,"quantity":2}]}'

Berechtigungen

Ein Token trägt nur die Berechtigungen, die ihm gegeben wurden, und jeder Endpunkt verlangt eine davon.

menu:read
menu:write
orders:read
orders:write
reservations:read
reservations:write
guests:read
reports:read

API-Referenz

{
    "data": [
        {
            "id": 3,
            "name": {
                "en": "Dinner"
            },
            "is_active": true,
            "sort_order": 0,
            "categories": [
                {
                    "id": 7,
                    "menu_id": 3,
                    "name": {
                        "en": "Mains"
                    },
                    "is_active": true,
                    "sort_order": 0
                }
            ]
        }
    ],
    "meta": {
        "count": 1,
        "currency": "EUR"
    },
    "links": {}
}

GET/menus/{menu}

One menu, its categories and their dishes

meta.now says what menus by time of day and happy hours make of the menu right now, on the default branch's clock: whether it and each category are open, and each dish or size a happy hour has cut, at the price charged now.

Berechtigung: menu:read

Parameter
Name	In	Typ	Erforderlich
`menu`	path	integer	Erforderlich

Beispielantwort 200

{
    "data": {
        "id": 3,
        "name": {
            "en": "Dinner"
        },
        "is_active": true,
        "sort_order": 0,
        "categories": [
            {
                "id": 7,
                "menu_id": 3,
                "name": {
                    "en": "Mains"
                },
                "is_active": true,
                "sort_order": 0,
                "items": [
                    {
                        "id": 42,
                        "category_id": 7,
                        "name": {
                            "en": "Burger"
                        },
                        "description": {
                            "en": "Beef, brioche"
                        },
                        "price_minor": 1100,
                        "is_available": true,
                        "show_online": true,
                        "dietary": "none",
                        "allergens": [
                            "gluten",
                            "milk"
                        ],
                        "sort_order": 1,
                        "variants": [],
                        "modifier_groups": [],
                        "updated_at": "2026-09-29T10:12:00+00:00"
                    }
                ]
            }
        ]
    },
    "meta": {
        "currency": "EUR",
        "now": {
            "available": true,
            "closed_category_ids": [],
            "prices": []
        }
    },
    "links": {}
}

GET/categories

Every category, or one menu's

Berechtigung: menu:read

Parameter
Name	In	Typ	Erforderlich
`menu_id`	query	integer	Optional

Beispielantwort 200

{
    "data": [
        {
            "id": 7,
            "menu_id": 3,
            "name": {
                "en": "Mains"
            },
            "is_active": true,
            "sort_order": 0
        }
    ],
    "meta": {
        "count": 1
    },
    "links": {}
}

GET/items

Dishes, a page at a time

Berechtigung: menu:read

Parameter
Name	In	Typ	Erforderlich
`category_id`	query	integer	Optional
`available`	query	string: "true", "false", "1", "0"	Optional
`per_page`	query	integer	Optional
`cursor`	query	string	Optional

Beispielantwort 200

{
    "data": [
        {
            "id": 42,
            "category_id": 7,
            "name": {
                "en": "Burger"
            },
            "description": null,
            "price_minor": 1100,
            "is_available": true,
            "show_online": true,
            "dietary": "none",
            "allergens": null,
            "sort_order": 1,
            "variants": [],
            "modifier_groups": [],
            "updated_at": "2026-09-29T10:12:00+00:00"
        }
    ],
    "meta": {
        "currency": "EUR",
        "per_page": 25,
        "next_cursor": null,
        "prev_cursor": null
    },
    "links": {
        "next": null,
        "prev": null
    }
}

POST/items

Add a dish

name and description are a string in the restaurant's default language, or a translation map. A dish is priced by price_minor, or per size by variants.

Berechtigung: menu:write

Parameter
Name	In	Typ	Erforderlich
`Idempotency-Key`	header	string	Optional

Anfragetext

{
    "category_id": 7,
    "name": "Burger",
    "price_minor": 1100,
    "allergens": [
        "gluten"
    ]
}

Beispielantwort 201

{
    "data": {
        "id": 42,
        "category_id": 7,
        "name": {
            "en": "Burger"
        },
        "description": {
            "en": "Beef, brioche"
        },
        "price_minor": 1100,
        "is_available": true,
        "show_online": true,
        "dietary": "none",
        "allergens": [
            "gluten",
            "milk"
        ],
        "sort_order": 1,
        "variants": [],
        "modifier_groups": [
            {
                "id": 5,
                "name": {
                    "en": "Extras"
                },
                "min_select": 0,
                "max_select": null,
                "options": [
                    {
                        "id": 9,
                        "name": {
                            "en": "Cheese"
                        },
                        "price_minor": 100,
                        "is_available": true
                    }
                ]
            }
        ],
        "updated_at": "2026-09-29T10:12:00+00:00"
    },
    "meta": {
        "currency": "USD"
    },
    "links": {}
}

GET/items/{item}

One dish

Berechtigung: menu:read

Parameter
Name	In	Typ	Erforderlich
`item`	path	integer	Erforderlich

Beispielantwort 200

{
    "data": {
        "id": 42,
        "category_id": 7,
        "name": {
            "en": "Burger"
        },
        "description": {
            "en": "Beef, brioche"
        },
        "price_minor": 1100,
        "is_available": true,
        "show_online": true,
        "dietary": "none",
        "allergens": [
            "gluten",
            "milk"
        ],
        "sort_order": 1,
        "variants": [],
        "modifier_groups": [
            {
                "id": 5,
                "name": {
                    "en": "Extras"
                },
                "min_select": 0,
                "max_select": null,
                "options": [
                    {
                        "id": 9,
                        "name": {
                            "en": "Cheese"
                        },
                        "price_minor": 100,
                        "is_available": true
                    }
                ]
            }
        ],
        "updated_at": "2026-09-29T10:12:00+00:00"
    },
    "meta": {
        "currency": "USD"
    },
    "links": {}
}

PATCH/items/{item}

Change a dish

Only the fields sent change; variants and modifier groups are kept. A price change is recorded in the activity log. A dish priced per size refuses price_minor.

Berechtigung: menu:write

Parameter
Name	In	Typ	Erforderlich
`item`	path	integer	Erforderlich

Anfragetext

{
    "price_minor": 1250
}

Beispielantwort 200

{
    "data": {
        "id": 42,
        "category_id": 7,
        "name": {
            "en": "Burger"
        },
        "description": {
            "en": "Beef, brioche"
        },
        "price_minor": 1100,
        "is_available": true,
        "show_online": true,
        "dietary": "none",
        "allergens": [
            "gluten",
            "milk"
        ],
        "sort_order": 1,
        "variants": [],
        "modifier_groups": [
            {
                "id": 5,
                "name": {
                    "en": "Extras"
                },
                "min_select": 0,
                "max_select": null,
                "options": [
                    {
                        "id": 9,
                        "name": {
                            "en": "Cheese"
                        },
                        "price_minor": 100,
                        "is_available": true
                    }
                ]
            }
        ],
        "updated_at": "2026-09-29T10:12:00+00:00"
    },
    "meta": {
        "currency": "USD"
    },
    "links": {}
}

PUT/items/{item}/availability

Sold out, and back

Recorded like a flip on the till.

Berechtigung: menu:write

Parameter
Name	In	Typ	Erforderlich
`item`	path	integer	Erforderlich

Anfragetext

{
    "is_available": false
}

Beispielantwort 200

{
    "data": {
        "id": 42,
        "category_id": 7,
        "name": {
            "en": "Burger"
        },
        "description": {
            "en": "Beef, brioche"
        },
        "price_minor": 1100,
        "is_available": true,
        "show_online": true,
        "dietary": "none",
        "allergens": [
            "gluten",
            "milk"
        ],
        "sort_order": 1,
        "variants": [],
        "modifier_groups": [
            {
                "id": 5,
                "name": {
                    "en": "Extras"
                },
                "min_select": 0,
                "max_select": null,
                "options": [
                    {
                        "id": 9,
                        "name": {
                            "en": "Cheese"
                        },
                        "price_minor": 100,
                        "is_available": true
                    }
                ]
            }
        ],
        "updated_at": "2026-09-29T10:12:00+00:00"
    },
    "meta": {
        "currency": "USD"
    },
    "links": {}
}

Orders

4 Endpunkte

Orders on any channel, and their status.

GET/orders

Orders, newest first

Berechtigung: orders:read

Parameter
Name	In	Typ	Erforderlich
`status`	query	string	Optional
`type`	query	string: "dine_in", "pickup", "delivery"	Optional
`channel`	query	string	Optional
`placed_from`	query	string	Optional
`placed_to`	query	string	Optional
`updated_since`	query	string	Optional
`per_page`	query	integer	Optional
`cursor`	query	string	Optional

Beispielantwort 200

{
    "data": [],
    "meta": {
        "per_page": 25,
        "next_cursor": null,
        "prev_cursor": null
    },
    "links": {
        "next": null,
        "prev": null
    }
}

POST/orders

Place an order

The order is priced from the menu (any price in the body is ignored), the owner's ordering rules apply (types offered, minimum order, delivery zones, opening hours; an order outside hours is held for the next opening), the kitchen gets its tickets and a connected POS gets the order. Dine-in orders need table_code.

Berechtigung: orders:write

Parameter
Name	In	Typ	Erforderlich
`Idempotency-Key`	header	string	Optional

Anfragetext

{
    "type": "delivery",
    "channel": "web",
    "customer_name": "Ada Lovelace",
    "customer_phone": "+15550100",
    "customer_email": "ada@example.com",
    "note": "Ring twice",
    "delivery_address": {
        "line1": "12 Main St",
        "city": "Springfield"
    },
    "lines": [
        {
            "item_id": 42,
            "quantity": 2,
            "option_ids": [
                9
            ]
        },
        {
            "item_id": 43,
            "variant_id": 11,
            "quantity": 1
        }
    ]
}

Beispielantwort 201

{
    "data": {
        "id": "9d1c7a52-8f0e-4b8c-a1f5-3a1a5b1f0c2d",
        "status": "placed",
        "type": "delivery",
        "channel": "web",
        "branch_id": 1,
        "table": null,
        "customer": {
            "name": "Ada Lovelace",
            "phone": "+15550100",
            "email": "ada@example.com"
        },
        "note": "Ring twice",
        "delivery_address": {
            "line1": "12 Main St",
            "city": "Springfield"
        },
        "currency": "USD",
        "subtotal_minor": 2300,
        "discount_minor": 0,
        "service_charge_minor": 0,
        "tax_added_minor": 0,
        "delivery_fee_minor": 300,
        "total_minor": 2600,
        "tax_breakdown": null,
        "cancel_reason": null,
        "items": [
            {
                "id": 1,
                "item_id": 42,
                "name": {
                    "en": "Burger"
                },
                "variant_name": null,
                "quantity": 2,
                "unit_price_minor": 1200,
                "line_total_minor": 2400,
                "voided": false,
                "modifiers": [
                    {
                        "name": {
                            "en": "Cheese"
                        },
                        "price_minor": 100
                    }
                ]
            }
        ],
        "placed_at": "2026-09-29T10:15:00+00:00",
        "scheduled_for": null,
        "paid_at": null,
        "updated_at": "2026-09-29T10:15:00+00:00"
    },
    "meta": {},
    "links": {}
}

GET/orders/{order}

One order

Berechtigung: orders:read

Parameter
Name	In	Typ	Erforderlich
`order`	path	string	Erforderlich

Beispielantwort 200

{
    "data": {
        "id": "9d1c7a52-8f0e-4b8c-a1f5-3a1a5b1f0c2d",
        "status": "placed",
        "type": "delivery",
        "channel": "web",
        "branch_id": 1,
        "table": null,
        "customer": {
            "name": "Ada Lovelace",
            "phone": "+15550100",
            "email": "ada@example.com"
        },
        "note": "Ring twice",
        "delivery_address": {
            "line1": "12 Main St",
            "city": "Springfield"
        },
        "currency": "USD",
        "subtotal_minor": 2300,
        "discount_minor": 0,
        "service_charge_minor": 0,
        "tax_added_minor": 0,
        "delivery_fee_minor": 300,
        "total_minor": 2600,
        "tax_breakdown": null,
        "cancel_reason": null,
        "items": [
            {
                "id": 1,
                "item_id": 42,
                "name": {
                    "en": "Burger"
                },
                "variant_name": null,
                "quantity": 2,
                "unit_price_minor": 1200,
                "line_total_minor": 2400,
                "voided": false,
                "modifiers": [
                    {
                        "name": {
                            "en": "Cheese"
                        },
                        "price_minor": 100
                    }
                ]
            }
        ],
        "placed_at": "2026-09-29T10:15:00+00:00",
        "scheduled_for": null,
        "paid_at": null,
        "updated_at": "2026-09-29T10:15:00+00:00"
    },
    "meta": {},
    "links": {}
}

POST/orders/{order}/status

Move an order one step

placed to accepted or rejected, accepted to ready, ready to completed, and anything not finished to cancelled. Accepting fires the kitchen. A cancel with a reason (3 to 200 characters) also voids the kitchen tickets and keeps the reason.

Berechtigung: orders:write

Parameter
Name	In	Typ	Erforderlich
`order`	path	string	Erforderlich
`Idempotency-Key`	header	string	Optional

Anfragetext

{
    "status": "accepted"
}

Beispielantwort 200

{
    "data": {
        "id": "9d1c7a52-8f0e-4b8c-a1f5-3a1a5b1f0c2d",
        "status": "placed",
        "type": "delivery",
        "channel": "web",
        "branch_id": 1,
        "table": null,
        "customer": {
            "name": "Ada Lovelace",
            "phone": "+15550100",
            "email": "ada@example.com"
        },
        "note": "Ring twice",
        "delivery_address": {
            "line1": "12 Main St",
            "city": "Springfield"
        },
        "currency": "USD",
        "subtotal_minor": 2300,
        "discount_minor": 0,
        "service_charge_minor": 0,
        "tax_added_minor": 0,
        "delivery_fee_minor": 300,
        "total_minor": 2600,
        "tax_breakdown": null,
        "cancel_reason": null,
        "items": [
            {
                "id": 1,
                "item_id": 42,
                "name": {
                    "en": "Burger"
                },
                "variant_name": null,
                "quantity": 2,
                "unit_price_minor": 1200,
                "line_total_minor": 2400,
                "voided": false,
                "modifiers": [
                    {
                        "name": {
                            "en": "Cheese"
                        },
                        "price_minor": 100
                    }
                ]
            }
        ],
        "placed_at": "2026-09-29T10:15:00+00:00",
        "scheduled_for": null,
        "paid_at": null,
        "updated_at": "2026-09-29T10:15:00+00:00"
    },
    "meta": {},
    "links": {}
}

Reservations

5 Endpunkte

Bookings and table availability. Needs a plan with reservations.

GET/reservations

Bookings for a day or a range

Berechtigung: reservations:read

Parameter
Name	In	Typ	Erforderlich
`date`	query	string	Optional
`from`	query	string	Optional
`to`	query	string	Optional
`status`	query	string: "pending", "confirmed", "declined", "cancelled", "seated", "no_show"	Optional
`per_page`	query	integer	Optional
`cursor`	query	string	Optional

Beispielantwort 200

{
    "data": [],
    "meta": {
        "per_page": 25,
        "next_cursor": null,
        "prev_cursor": null
    },
    "links": {
        "next": null,
        "prev": null
    }
}

POST/reservations

Write a booking down

The booking rules apply (party size, lead time, closing days); the guest gets the same confirmation as for a phone booking.

Berechtigung: reservations:write

Parameter
Name	In	Typ	Erforderlich
`Idempotency-Key`	header	string	Optional

Anfragetext

{
    "name": "Ada Lovelace",
    "phone": "+15550100",
    "party_size": 2,
    "date": "2026-10-03",
    "time": "19:30"
}

Beispielantwort 201

{
    "data": {
        "id": "1b6e1c1e-2f4f-4c43-9e0e-4b9d6f1a2c3d",
        "status": "confirmed",
        "name": "Ada Lovelace",
        "phone": "+15550100",
        "email": null,
        "party_size": 2,
        "date": "2026-10-03",
        "time": "19:30",
        "table_id": null,
        "note": null,
        "deposit_minor": null,
        "deposit_status": null,
        "created_at": "2026-10-01T09:00:00+00:00",
        "updated_at": "2026-10-01T09:00:00+00:00"
    },
    "meta": {},
    "links": {}
}

GET/availability

Bookable times for a day and a party

Berechtigung: reservations:read

Parameter
Name	In	Typ	Erforderlich
`date`	query	string	Erforderlich
`party_size`	query	integer	Erforderlich

Beispielantwort 200

{
    "data": {
        "date": "2026-10-03",
        "party_size": 2,
        "engine": true,
        "slots": [
            {
                "time": "19:00",
                "available": true,
                "guarantee": false
            },
            {
                "time": "19:30",
                "available": false,
                "guarantee": false
            }
        ],
        "guarantee": null,
        "notify": true
    },
    "meta": {},
    "links": {}
}

GET/reservations/{reservation}

One booking

Berechtigung: reservations:read

Parameter
Name	In	Typ	Erforderlich
`reservation`	path	string	Erforderlich

Beispielantwort 200

{
    "data": {
        "id": "1b6e1c1e-2f4f-4c43-9e0e-4b9d6f1a2c3d",
        "status": "confirmed",
        "name": "Ada Lovelace",
        "phone": "+15550100",
        "email": null,
        "party_size": 2,
        "date": "2026-10-03",
        "time": "19:30",
        "table_id": null,
        "note": null,
        "deposit_minor": null,
        "deposit_status": null,
        "created_at": "2026-10-01T09:00:00+00:00",
        "updated_at": "2026-10-01T09:00:00+00:00"
    },
    "meta": {},
    "links": {}
}

POST/reservations/{reservation}/cancel

Cancel a booking

Cancelled by the restaurant; the guest is told.

Berechtigung: reservations:write

Parameter
Name	In	Typ	Erforderlich
`reservation`	path	string	Erforderlich
`Idempotency-Key`	header	string	Optional

Beispielantwort 200

{
    "data": {
        "id": "1b6e1c1e-2f4f-4c43-9e0e-4b9d6f1a2c3d",
        "status": "confirmed",
        "name": "Ada Lovelace",
        "phone": "+15550100",
        "email": null,
        "party_size": 2,
        "date": "2026-10-03",
        "time": "19:30",
        "table_id": null,
        "note": null,
        "deposit_minor": null,
        "deposit_status": null,
        "created_at": "2026-10-01T09:00:00+00:00",
        "updated_at": "2026-10-01T09:00:00+00:00"
    },
    "meta": {},
    "links": {}
}

Guests

2 Endpunkte

Guest profiles, with contact details only for guests who agreed to share them.

GET/guests

Guest profiles, a page at a time

Guests who asked to be forgotten never appear. Phone and email are included only for guests who agreed to hear from the restaurant. Staff notes are never included.

Berechtigung: guests:read

Parameter
Name	In	Typ	Erforderlich
`marketing_opted_in`	query	string: "true", "false", "1", "0"	Optional
`updated_since`	query	string	Optional
`per_page`	query	integer	Optional
`cursor`	query	string	Optional

Beispielantwort 200

{
    "data": [
        {
            "id": 5,
            "name": "Ada Lovelace",
            "phone": "+15550100",
            "email": "ada@example.com",
            "contact_shared": true,
            "locale": "en",
            "marketing_opted_in": true,
            "marketing_opted_in_at": "2026-09-01T12:00:00+00:00",
            "visits_count": 4,
            "total_spend_minor": 9200,
            "last_visit_at": "2026-09-28T20:15:00+00:00",
            "created_at": "2026-06-02T19:40:00+00:00"
        }
    ],
    "meta": {
        "per_page": 25,
        "next_cursor": null,
        "prev_cursor": null
    },
    "links": {
        "next": null,
        "prev": null
    }
}

GET/guests/{guest}

One guest profile

Berechtigung: guests:read

Parameter
Name	In	Typ	Erforderlich
`guest`	path	integer	Erforderlich

Beispielantwort 200

{
    "data": {
        "id": 6,
        "name": "Alan Turing",
        "phone": null,
        "email": null,
        "contact_shared": false,
        "locale": null,
        "marketing_opted_in": false,
        "marketing_opted_in_at": null,
        "visits_count": 1,
        "total_spend_minor": 2400,
        "last_visit_at": null,
        "created_at": "2026-09-30T11:00:00+00:00"
    },
    "meta": {},
    "links": {}
}

Reports

1 Endpunkte

Sales figures. Needs a plan with reporting.

GET/reports/sales-summary

Revenue, orders and average order for a period

With the preceding period of the same length. Defaults to today on the restaurant's clock; at most 366 days.

Berechtigung: reports:read

Parameter
Name	In	Typ	Erforderlich
`from`	query	string	Optional
`to`	query	string	Optional
`branch_id`	query	integer	Optional

Beispielantwort 200

{
    "data": {
        "from": "2026-09-01",
        "to": "2026-09-30",
        "branch_id": null,
        "currency": "EUR",
        "orders": 812,
        "revenue_minor": 1843200,
        "average_order_minor": 2270,
        "previous": {
            "orders": 760,
            "revenue_minor": 1690000,
            "average_order_minor": 2223
        },
        "change": {
            "revenue_pct": 9.1,
            "orders_pct": 6.8
        }
    },
    "meta": {},
    "links": {}
}

OAuth

2 Endpunkte

Apps from the marketplace: a venue owner allows an app on the consent screen, and the app exchanges the code for an access token (used as the bearer token of every operation above) and a refresh token. Authorization code with PKCE (S256).

POST/oauth/token

Exchange a code, or refresh, for tokens

authorization_code: redeem the code the venue's consent sent to your redirect address, with the PKCE verifier. refresh_token: get a new access token and a new refresh token; the old pair stops working. Authenticate with your client id and secret, as HTTP Basic or as client_id and client_secret in the body. Answers are never cached.

Anfragetext

{
    "grant_type": "authorization_code",
    "code": "bnd_ac_9fK2...",
    "redirect_uri": "https://app.example.com/callback",
    "code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
    "client_id": "bnd_app_4kq8...",
    "client_secret": "bnd_cs_..."
}

Beispielantwort 200

{
    "access_token": "812|bnd_oat_Xf3k...",
    "token_type": "Bearer",
    "expires_in": 3600,
    "refresh_token": "bnd_ort_q8Lz...",
    "scope": "menu:read orders:read"
}

POST/oauth/revoke

Revoke a token

Gives back a refresh token (with its access token) or an access token (RFC 7009). An unknown token is not an error. Authenticate with your client id and secret, as HTTP Basic or as client_id and client_secret in the body. To end the whole grant, the venue uninstalls the app.

Anfragetext

{
    "token": "bnd_ort_q8Lz...",
    "client_id": "bnd_app_4kq8...",
    "client_secret": "bnd_cs_..."
}

Beispielantwort 200

{}

Webhooks

Fügen Sie unter Einstellungen, dann Entwickler, eine https-Adresse hinzu und wählen Sie ihre Ereignisse. Jede Zustellung ist ein signierter POST: Antworten Sie innerhalb von 10 Sekunden mit einem beliebigen 2xx. Ein Fehlschlag wird nach 1 Minute, 5 Minuten, 30 Minuten, 2 Stunden und 6 Stunden erneut versucht, und das Zustellprotokoll kann ihn wiederholen.

Ereignisse

order.created: Eine Bestellung wird über einen beliebigen Kanal aufgegeben.
order.status_changed: Eine Bestellung wechselt in einen anderen Status.
order.paid: Zahlungen decken die Bestellung ab.
reservation.created: Eine Reservierung wird vom Gast oder vom Personal angelegt.
reservation.updated: Eine Reservierung ändert sich.
reservation.cancelled: Eine Reservierung wird storniert.
menu.item_updated: Ein Gericht ändert sich: Preis, Name, ausverkauft.
payment.refunded: Eine Zahlung wird erstattet.
guest.created: Ein Gastprofil wird angelegt.
guest.updated: Die Daten oder die Einwilligung eines Gastes ändern sich, oder der Gast wird gelöscht.
giftcard.issued: Eine Geschenkkarte wird verkauft oder ausgestellt.
giftcard.redeemed: Eine Geschenkkarte bezahlt eine Bestellung.
review.created: Ein Gast gibt eine Bewertung ab.
stock.below_par: Eine Zutat fällt in einer Filiale unter ihren Sollbestand.
shift.published: Ein Manager veröffentlicht eine Schichtwoche.
experience.booked: Tickets für ein Erlebnis werden bezahlt.

Signatur prüfen

BookNDish-Signature enthält t, eine Unix-Zeit, und v1, den hexadezimalen HMAC-SHA256 aus t, einem Punkt und dem rohen Body, berechnet mit Ihrem Signaturgeheimnis. Vergleichen Sie in konstanter Zeit und lehnen Sie ein t ab, das älter als fünf Minuten ist.

function bookndishSignatureIsValid(string $payload, string $header, string $secret, int $tolerance = 300): bool
{
    $parts = [];
    foreach (explode(',', $header) as $pair) {
        [$key, $value] = array_pad(explode('=', trim($pair), 2), 2, '');
        $parts[$key][] = $value;
    }

    $timestamp = (int) ($parts['t'][0] ?? 0);
    if ($timestamp === 0 || abs(time() - $timestamp) > $tolerance) {
        return false;
    }

    $expected = hash_hmac('sha256', $timestamp.'.'.$payload, $secret);
    foreach ($parts['v1'] ?? [] as $signature) {
        if (hash_equals($expected, $signature)) {
            return true;
        }
    }

    return false;
}

Sandbox

Eine Sandbox ist ein eigenes Beispiellokal mit Speisekarte, Tischen, Gästen, einer Reservierung und einer Bestellung, hinter einem Token mit allen Berechtigungen. Sie antwortet unter derselben Adresse mit einem BookNDish-Sandbox-Header, berührt nie das echte Restaurant und kehrt jede Nacht zu ihren Beispieldaten zurück.

Erstellen Sie eine unter Einstellungen, dann Entwickler, dann Sandbox. Ihr Token beginnt mit bnd_sbx_.

Limits und Fehler

Jeder Token darf standardmäßig 60 Anfragen pro Minute stellen. Jede Antwort enthält X-RateLimit-Remaining, und ein 429 enthält Retry-After.
Ein Fehler antwortet mit error.code, error.message und error.details. Ein Token sieht immer nur sein eigenes Restaurant: Alles andere ist ein 404.
v1 wächst nur: neue Endpunkte, optionale Felder und Ereignisse. Eine Änderung, die einen Client brechen würde, kommt in v2, und v1 bleibt daneben bestehen.

Bauen Sie auf BookNDish auf

Schnellstart

Token holen

API aufrufen

Sicher schreiben

Berechtigungen

API-Referenz

Menu

Orders

Reservations

Guests

Reports

OAuth

Webhooks

Ereignisse

Signatur prüfen

Sandbox

Limits und Fehler