API BookNDish

Construisez sur BookNDish

Une API REST documentée, des webhooks signés et un bac à sable gratuit. Connectez un site web, un écran de cuisine, un CRM ou un outil de comptabilité à n'importe quel restaurant sur BookNDish, avec l'autorisation du propriétaire.

Créer un jeton OpenAPI (YAML)OpenAPI (JSON)

La référence de l'API ci-dessous est rédigée en anglais.

Démarrage rapide

01
Obtenez un jeton
Le propriétaire du restaurant ou un responsable ouvre Réglages, puis Développeurs, et crée un jeton avec les portées dont votre intégration a besoin, ou un jeton de bac à sable pour démarrer sur des données d'exemple. Un jeton appartient à un seul restaurant et n'est affiché qu'une fois.
02
Appelez l'API
Envoyez le jeton comme jeton Bearer. Chaque réponse est en JSON avec data, meta et links.
03
Écrivez en toute sécurité
Donnez à chaque POST un Idempotency-Key. Une nouvelle tentative avec la même clé renvoie la première réponse, et rien ne s'exécute deux fois.

URL de base: 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}]}'

Portées

Un jeton ne porte que les portées qui lui ont été données, et chaque point d'accès en exige une.

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

Référence de l'API

{
    "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.

Portée: menu:read

Paramètres
Nom	Dans	Type	Obligatoire
`menu`	path	integer	Obligatoire

Exemple de réponse 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

Portée: menu:read

Paramètres
Nom	Dans	Type	Obligatoire
`menu_id`	query	integer	Facultatif

Exemple de réponse 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

Portée: menu:read

Paramètres
Nom	Dans	Type	Obligatoire
`category_id`	query	integer	Facultatif
`available`	query	string: "true", "false", "1", "0"	Facultatif
`per_page`	query	integer	Facultatif
`cursor`	query	string	Facultatif

Exemple de réponse 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.

Portée: menu:write

Paramètres
Nom	Dans	Type	Obligatoire
`Idempotency-Key`	header	string	Facultatif

Corps de la requête

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

Exemple de réponse 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

Portée: menu:read

Paramètres
Nom	Dans	Type	Obligatoire
`item`	path	integer	Obligatoire

Exemple de réponse 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.

Portée: menu:write

Paramètres
Nom	Dans	Type	Obligatoire
`item`	path	integer	Obligatoire

Corps de la requête

{
    "price_minor": 1250
}

Exemple de réponse 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.

Portée: menu:write

Paramètres
Nom	Dans	Type	Obligatoire
`item`	path	integer	Obligatoire

Corps de la requête

{
    "is_available": false
}

Exemple de réponse 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 points d'accès

Orders on any channel, and their status.

GET/orders

Orders, newest first

Portée: orders:read

Paramètres
Nom	Dans	Type	Obligatoire
`status`	query	string	Facultatif
`type`	query	string: "dine_in", "pickup", "delivery"	Facultatif
`channel`	query	string	Facultatif
`placed_from`	query	string	Facultatif
`placed_to`	query	string	Facultatif
`updated_since`	query	string	Facultatif
`per_page`	query	integer	Facultatif
`cursor`	query	string	Facultatif

Exemple de réponse 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.

Portée: orders:write

Paramètres
Nom	Dans	Type	Obligatoire
`Idempotency-Key`	header	string	Facultatif

Corps de la requête

{
    "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
        }
    ]
}

Exemple de réponse 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

Portée: orders:read

Paramètres
Nom	Dans	Type	Obligatoire
`order`	path	string	Obligatoire

Exemple de réponse 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.

Portée: orders:write

Paramètres
Nom	Dans	Type	Obligatoire
`order`	path	string	Obligatoire
`Idempotency-Key`	header	string	Facultatif

Corps de la requête

{
    "status": "accepted"
}

Exemple de réponse 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 points d'accès

Bookings and table availability. Needs a plan with reservations.

GET/reservations

Bookings for a day or a range

Portée: reservations:read

Paramètres
Nom	Dans	Type	Obligatoire
`date`	query	string	Facultatif
`from`	query	string	Facultatif
`to`	query	string	Facultatif
`status`	query	string: "pending", "confirmed", "declined", "cancelled", "seated", "no_show"	Facultatif
`per_page`	query	integer	Facultatif
`cursor`	query	string	Facultatif

Exemple de réponse 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.

Portée: reservations:write

Paramètres
Nom	Dans	Type	Obligatoire
`Idempotency-Key`	header	string	Facultatif

Corps de la requête

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

Exemple de réponse 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

Portée: reservations:read

Paramètres
Nom	Dans	Type	Obligatoire
`date`	query	string	Obligatoire
`party_size`	query	integer	Obligatoire

Exemple de réponse 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

Portée: reservations:read

Paramètres
Nom	Dans	Type	Obligatoire
`reservation`	path	string	Obligatoire

Exemple de réponse 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.

Portée: reservations:write

Paramètres
Nom	Dans	Type	Obligatoire
`reservation`	path	string	Obligatoire
`Idempotency-Key`	header	string	Facultatif

Exemple de réponse 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 points d'accès

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.

Portée: guests:read

Paramètres
Nom	Dans	Type	Obligatoire
`marketing_opted_in`	query	string: "true", "false", "1", "0"	Facultatif
`updated_since`	query	string	Facultatif
`per_page`	query	integer	Facultatif
`cursor`	query	string	Facultatif

Exemple de réponse 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

Portée: guests:read

Paramètres
Nom	Dans	Type	Obligatoire
`guest`	path	integer	Obligatoire

Exemple de réponse 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 points d'accès

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.

Portée: reports:read

Paramètres
Nom	Dans	Type	Obligatoire
`from`	query	string	Facultatif
`to`	query	string	Facultatif
`branch_id`	query	integer	Facultatif

Exemple de réponse 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 points d'accès

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.

Corps de la requête

{
    "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_..."
}

Exemple de réponse 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.

Corps de la requête

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

Exemple de réponse 200

{}

Webhooks

Ajoutez une adresse https dans Réglages, puis Développeurs, et choisissez ses événements. Chaque envoi est un POST signé : répondez avec n'importe quel code 2xx en moins de 10 secondes. Un échec est retenté après 1 minute, 5 minutes, 30 minutes, 2 heures et 6 heures, et le journal des envois peut le rejouer.

Événements

order.created: Une commande est passée sur n'importe quel canal.
order.status_changed: Une commande passe à un autre statut.
order.paid: Les paiements couvrent la commande.
reservation.created: Une réservation est faite, par le client ou par l'équipe.
reservation.updated: Une réservation est modifiée.
reservation.cancelled: Une réservation est annulée.
menu.item_updated: Un plat change : prix, nom, épuisé.
payment.refunded: Un paiement est remboursé.
guest.created: Un profil client est créé.
guest.updated: Les informations ou le consentement d'un client changent, ou le client est effacé.
giftcard.issued: Une carte cadeau est vendue ou émise.
giftcard.redeemed: Une carte cadeau règle une commande.
review.created: Un client laisse une note.
stock.below_par: Un ingrédient passe sous son niveau de référence dans un établissement.
shift.published: Un responsable publie une semaine de services.
experience.booked: Les billets d'une expérience sont payés.

Vérifier la signature

BookNDish-Signature contient t, une heure Unix, et v1, le HMAC-SHA256 hexadécimal de t, d'un point et du corps brut, calculé avec votre secret de signature. Comparez en temps constant et refusez un t vieux de plus de cinq minutes.

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;
}

Bac à sable

Un bac à sable est un établissement d'exemple à part, avec un menu, des tables, des clients, une réservation et une commande, derrière un seul jeton disposant de toutes les portées. Il répond à la même adresse avec un en-tête BookNDish-Sandbox, ne touche jamais le restaurant réel et revient à ses données d'exemple chaque nuit.

Créez-en un dans Réglages, puis Développeurs, puis Bac à sable. Son jeton commence par bnd_sbx_.

Limites et erreurs

Chaque jeton peut faire 60 requêtes par minute par défaut. Chaque réponse contient X-RateLimit-Remaining, et un 429 contient Retry-After.
Un échec répond avec error.code, error.message et error.details. Un jeton ne voit jamais que son propre restaurant : tout le reste donne un 404.
v1 ne fait que s'enrichir : nouveaux points d'accès, champs facultatifs et événements. Un changement qui casserait un client va dans v2, et v1 est conservée à côté.

Construisez sur BookNDish

Démarrage rapide

Obtenez un jeton

Appelez l'API

Écrivez en toute sécurité

Portées

Référence de l'API

Menu

Orders

Reservations

Guests

Reports

OAuth

Webhooks

Événements

Vérifier la signature

Bac à sable

Limites et erreurs