Anmelden um den Slug und den veröffentlichbaren Schlüssel Ihrer Location in jedem Beispiel zu sehen.
Ihr Konto hat noch keine Location, die Beispiele behalten daher ihre Platzhalter. Abmelden
Angemeldet als · . Legen Sie in der Konsole einen veröffentlichbaren Schlüssel an und laden Sie die Seite neu, um ihn hier zu sehen. Abmelden
Angemeldet als · . Die Beispiele zeigen den veröffentlichbaren Schlüssel Ihrer Location. Abmelden
Entwicklerdokumentation
Speisekarten
Jede veröffentlichte Speisekarte mit Gruppen und Positionen lesen, bepreist in der Währung der Location – die Anzeige-, nicht die Bestellkarte.
Jede veröffentlichte Speisekarte mit Gruppen und Positionen, bepreist in der Währung der Location. Das ist die Anzeige-Karte; woraus ein sitzender Gast bestellen kann, sind die menus der Tischsitzung (QR-Codes und Tischsitzungen). Er folgt denselben Schlüsselregeln wie der Rest von /api/venues/** (Schlüssel und Header) und antwortet mit 404 und einem Problem-Body, wenn keine Location diesen Slug hat.
Endpunkte
GET /api/venues/{venueSlug}/menus
Antwort 200 OK
| Feld | Typ | Bedeutung |
|---|---|---|
slug, currency |
string | Die Location und die ISO-4217-Währung jedes Preises darunter |
menus[] |
object[] | id, name, description, groups[] |
groups[] |
object[] | name, description (nullable), items[] |
items[] |
object[] | name, description, price (decimal), currency, tags (string[], z. B. Ernährungshinweise), imageUrl (nullable), id (nullable) — die dauerhafte Kennung des Artikels: Sie bleibt bei einer Umbenennung erhalten, also einen Artikel über id referenzieren, nicht über name. Nur bei einem Artikel null, der gespeichert wurde, bevor es IDs gab |
{
"slug": "demo-sportsbar",
"currency": "EUR",
"menus": [
{
"id": "kitchen",
"name": "Kitchen",
"description": "Served from open until one hour before close.",
"groups": [
{
"name": "Small plates",
"description": null,
"items": [
{
"name": "Loaded nachos",
"description": "Melted cheese, jalapeños, lime crema",
"price": 9.50,
"currency": "EUR",
"tags": [
"vegetarian"
],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/nachos.webp",
"id": "cccb4f0acf5604910b9edff5eb7d85d3"
},
{
"name": "Buffalo wings",
"description": "Blue-cheese dip, celery",
"price": 11.00,
"currency": "EUR",
"tags": [],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/wings.webp",
"id": "af1cc7fd0772f60da833b1612f46fa69"
},
{
"name": "Padrón peppers",
"description": "Sea salt, olive oil",
"price": 7.00,
"currency": "EUR",
"tags": [
"vegan",
"gluten-free"
],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/padron-peppers.webp",
"id": "08d1b4c209107e4e8b8bd809ee0dedf4"
}
]
},
{
"name": "Mains",
"description": null,
"items": [
{
"name": "Smash burger",
"description": "Double patty, house sauce, fries",
"price": 14.50,
"currency": "EUR",
"tags": [],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/smash-burger.webp",
"id": "787f5afafde1b8be62dc96b0db2e5735"
},
{
"name": "BBQ ribs",
"description": "Slow-cooked, slaw, fries",
"price": 19.00,
"currency": "EUR",
"tags": [],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/bbq-ribs.webp",
"id": "ead9e92d6a163e0e8fe95b27a7c96fa5"
},
{
"name": "Halloumi flatbread",
"description": "Grilled halloumi, harissa, greens",
"price": 13.00,
"currency": "EUR",
"tags": [
"vegetarian"
],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/halloumi-flatbread.webp",
"id": "655fa085e02ec363972091746b29e2cb"
}
]
},
{
"name": "Sweet",
"description": null,
"items": [
{
"name": "Churros",
"description": "Cinnamon sugar, chocolate",
"price": 7.00,
"currency": "EUR",
"tags": [
"vegetarian"
],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/churros.webp",
"id": "d668f32064f026a8ce33c30ebbd4cb5a"
}
]
}
]
},
{
"id": "bar",
"name": "Bar",
"description": "Draft, cocktails and zero-proof.",
"groups": [
{
"name": "Draft beer",
"description": null,
"items": [
{
"name": "House lager 0.3L",
"description": "Crisp pilsner",
"price": 4.50,
"currency": "EUR",
"tags": [],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/lager.webp",
"id": "139018ac588c888bddc135dcb72099f7"
},
{
"name": "Local IPA 0.5L",
"description": "Hoppy, citrus finish",
"price": 6.50,
"currency": "EUR",
"tags": [],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/ipa.webp",
"id": "f65791315063c5eb8a9006d8f85ba5b5"
}
]
},
{
"name": "Cocktails",
"description": null,
"items": [
{
"name": "Old Fashioned",
"description": "Bourbon, bitters, orange",
"price": 11.00,
"currency": "EUR",
"tags": [],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/old-fashioned.webp",
"id": "371c345ec3f606b3195ec7c5d596f418"
},
{
"name": "Spicy margarita",
"description": "Tequila, chilli, lime",
"price": 10.50,
"currency": "EUR",
"tags": [],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/margarita.webp",
"id": "cb63f7f8f82dcabc46206b49d34f641d"
}
]
},
{
"name": "Zero proof",
"description": null,
"items": [
{
"name": "Craft soda",
"description": "House-made, ask for today's flavour",
"price": 4.00,
"currency": "EUR",
"tags": [
"vegan"
],
"imageUrl": "_content/BookDinePlay.App.Shared/menu/craft-soda.webp",
"id": "af0cb8e85bf03fbc2e997bd4bdbe0136"
}
]
}
]
}
]
}Fehler – 404 keine Location mit diesem Slug.
curl
curl "https://api.bookdineplay.com/api/venues/your-venue/menus" \
-H "X-BookDinePlay-Key: bdp_pk_your_publishable_key" \
-H "Origin: https://www.your-venue.example"JavaScript
const { menus, currency } = await (await fetch('https://api.bookdineplay.com/api/venues/your-venue/menus', {
headers: { 'X-BookDinePlay-Key': 'bdp_pk_your_publishable_key' }
})).json();
for (const menu of menus) for (const group of menu.groups) for (const item of group.items) {
console.log(menu.name, group.name, item.name, item.price, currency);
}C#
var menus = await client.GetMenusAsync("your-venue", cancellationToken);PHP
<?php
$response = wp_remote_get( 'https://api.bookdineplay.com/api/venues/your-venue/menus', [ 'headers' => [ 'X-BookDinePlay-Key' => BOOKDINEPLAY_SECRET_KEY ] ] );
$data = json_decode( wp_remote_retrieve_body( $response ), true );
foreach ( $data['menus'] as $menu ) {
foreach ( $menu['groups'] as $group ) {
foreach ( $group['items'] as $item ) {
echo "{$menu['name']} {$group['name']} {$item['name']} {$item['price']} {$data['currency']}\n";
}
}
}Betreiber: Speisekarten speichern
Die Betreiberkonsole liest und speichert die Speisekarten einer Location über die Betreiber-API (Bearer-Token des Betreibers der Location), nicht über die öffentliche /api/venues/**-Oberfläche. Keine der beiden Routen ist an einen Tarif gebunden.
Lesen und speichern
GET /api/operator/venue/menusliefert jede Speisekarte mit ihrerid, ihrer Artkind(FoododerDrinks), ihren Gruppen und Artikeln, jeden Artikel mittaxRate(ein Anteil,0.19für 19 %) undid, dazu einenETag-Header. Ein Mandant ohne Location erhält204.PUT /api/operator/venue/menusmit{ "menus": [ … ] }ersetzt die gesamte Sammlung: Eine ausgelassene Speisekarte, Gruppe oder ein ausgelassener Artikel wird entfernt,[]leert alle Speisekarten. Die Antwort sind die gespeicherten Speisekarten und ihr neuerETag.- Senden Sie zurück, was Sie gelesen haben: Eine ausgelassene
imageUrlentfernt das Bild, und ein Artikel ohneidbehält die ID des gespeicherten Artikels derselben Speisekarte mit demselben Namen (sonst erhält er eine neue). Dieser Abgleich braucht dieidder Speisekarte selbst: Eine Speisekarte ohne sie gilt als neu, also erhält jeder ihrer Artikel eine neue ID, und alles, was auf die alten verwies, etwa ein Artikelgutschein, verliert die Verbindung. Eineid, die die Location nicht hat, oder eine doppelt verwendete wird mit400untererrors.menuabgelehnt, und nichts wird gespeichert.
Regeln für ein Speichern
Jede verletzte Regel ist ein 400-Validierungsproblem unter dem indizierten Schlüssel des Werts, zum Beispiel menus[0].groups[1].items[2].price, und es werden alle Fehler gemeldet, nicht nur der erste.
- Namen von Speisekarten, Gruppen und Artikeln sind Pflicht, höchstens 120 Zeichen; Beschreibungen höchstens 500.
- Ein Preis ist mindestens 0, höchstens 99.999,99, mit höchstens zwei Nachkommastellen.
- Eine
taxRateist leer (kein MwSt.-Satz) oder liegt zwischen 0 und 1. - Höchstens 12 Tags mit je höchstens 40 Zeichen; leere und doppelte Tags werden vor dem Zählen verworfen.
- Artikelnamen sind je Speisekarte eindeutig, verglichen ohne Leerzeichen am Rand und ohne Groß-/Kleinschreibung. Jeder Artikel eines Konflikts wird unter seinem
.namemarkiert: Die QR-Bestellung findet einen Artikel über Speisekarte und Namen, ein gleichnamiger würde einen Gast den falschen Preis zahlen lassen.
Nur speichern, was Sie gelesen haben
Senden Sie den ETag Ihres letzten Lesens als If-Match, um nur zu speichern, wenn die Speisekarten noch die gelesenen sind. Haben sie sich inzwischen geändert – ein anderes Gerät hat gespeichert oder ein Deployment hat eine Demo-Location zurückgesetzt –, lautet die Antwort 412 Precondition Failed, und nichts wird geschrieben; lesen Sie neu oder senden Sie das Speichern ohne If-Match, um zu überschreiben. Ohne If-Match ist ein Speichern unbedingt und antwortet im seltenen Fall, dass es gegen gleichzeitig eintreffende Speichervorgänge verliert, mit 409: Versuchen Sie es erneut.
curl
curl -i "https://api.bookdineplay.com/api/operator/venue/menus" \
-H "Authorization: Bearer $OPERATOR_TOKEN"
curl -X PUT "https://api.bookdineplay.com/api/operator/venue/menus" \
-H "Authorization: Bearer $OPERATOR_TOKEN" \
-H "If-Match: $ETAG" \
-H "Content-Type: application/json" \
-d @menus.jsonJavaScript
const url = 'https://api.bookdineplay.com/api/operator/venue/menus';
const headers = { 'Authorization': `Bearer ${process.env.OPERATOR_TOKEN}` }; // Node.js, server-side
const read = await fetch(url, { headers });
const etag = read.headers.get('ETag');
const { menus } = await read.json();
const save = await fetch(url, {
method: 'PUT',
headers: { ...headers, 'If-Match': etag, 'Content-Type': 'application/json' },
body: JSON.stringify({ menus }) // the whole collection
});
if (save.status === 412) { /* changed meanwhile - read again */ }C#
// `http` is an HttpClient with BaseAddress https://api.bookdineplay.com and the operator's bearer token.
using var read = await http.GetAsync("api/operator/venue/menus", cancellationToken);
var etag = read.Headers.ETag;
var menusJson = await read.Content.ReadAsStringAsync(cancellationToken);
using var request = new HttpRequestMessage(HttpMethod.Put, "api/operator/venue/menus")
{
Content = new StringContent(menusJson, Encoding.UTF8, "application/json")
};
request.Headers.IfMatch.Add(etag!);
using var save = await http.SendAsync(request, cancellationToken);
if (save.StatusCode == HttpStatusCode.PreconditionFailed) { /* changed meanwhile - read again */ }PHP
<?php
$url = 'https://api.bookdineplay.com/api/operator/venue/menus';
$headers = [ 'Authorization' => 'Bearer ' . OPERATOR_TOKEN ]; // server-side only
$read = wp_remote_get( $url, [ 'headers' => $headers ] );
$etag = wp_remote_retrieve_header( $read, 'etag' );
$save = wp_remote_request( $url, [
'method' => 'PUT',
'headers' => $headers + [ 'If-Match' => $etag, 'Content-Type' => 'application/json' ],
'body' => wp_remote_retrieve_body( $read ), // the whole collection
] );
if ( 412 === wp_remote_retrieve_response_code( $save ) ) { /* changed meanwhile - read again */ }Betreiber: Artikelbilder
Die Betreiberkonsole gibt einem Menüartikel in zwei Schritten ein Bild: Sie lädt die Datei hoch und speichert die zurückgegebene URL dann mit PUT /api/operator/venue/menus als imageUrl des Artikels. Das ist die Betreiber-API (Bearer-Token des Betreibers der Location), nicht Teil der öffentlichen /api/venues/**-Oberfläche.
Ein Bild hochladen
POST /api/operator/venue/menus/media nimmt multipart/form-data mit einem Teil file entgegen. Nicht an einen Tarif gebunden, wie der Menüeditor selbst. Für das Bild gelten dieselben Regeln wie für Veranstaltungsbilder: PNG, JPEG oder WebP (am Inhalt erkannt, nicht am angegebenen Typ), höchstens 5 MB, mindestens 400 × 400 Pixel und eine vollständige Datei.
Antwort 201 Created mit id, url, contentType, width und height. Speichern Sie url als imageUrl des Artikels.
Fehler – jeweils ein Problem-Body, der das Feld file benennt, damit eine Auswahl ihn neben sich anzeigen kann: 400 keine Datei, eine leere Datei, ein nicht unterstütztes oder abgeschnittenes Bild oder eines unter 400 × 400; 413 größer als 5 MB. Ein Mandant ohne Location erhält 404 mit einer einfachen Meldung.
curl
curl -X POST "https://api.bookdineplay.com/api/operator/venue/menus/media" \
-H "Authorization: Bearer $OPERATOR_TOKEN" \
-F "file=@burger.jpg"JavaScript
const form = new FormData();
form.append('file', imageFile); // a File or Blob
const response = await fetch('https://api.bookdineplay.com/api/operator/venue/menus/media', {
method: 'POST',
headers: { 'Authorization': `Bearer ${operatorToken}` }, // no Content-Type: the browser sets the boundary
body: form
});
const { url } = await response.json(); // save it as the item's imageUrlC#
using var form = new MultipartFormDataContent();
form.Add(new StreamContent(File.OpenRead("burger.jpg")), "file", "burger.jpg");
using var response = await http.PostAsync("api/operator/venue/menus/media", form, cancellationToken);
// `http` carries the operator's bearer token; the body holds id, url, contentType, width, heightPHP
<?php
// cURL: the WordPress HTTP API cannot send multipart uploads.
$ch = curl_init( 'https://api.bookdineplay.com/api/operator/venue/menus/media' );
curl_setopt_array( $ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . OPERATOR_TOKEN ],
CURLOPT_POSTFIELDS => [ 'file' => new CURLFile( 'burger.jpg' ) ],
CURLOPT_RETURNTRANSFER => true,
] );
$image = json_decode( curl_exec( $ch ), true ); // save $image['url'] as the item's imageUrl
curl_close( $ch );Welche imageUrl ein Speichern akzeptiert
PUT /api/operator/venue/menus akzeptiert als imageUrl eines Artikels einen leeren Wert (kein Bild), eine absolute http(s)-URL mit höchstens 2048 Zeichen – das, was der Upload zurückgibt – oder eines der mit der App gelieferten Bilder genau so, wie die Demo-Menüs sie speichern: _content/BookDinePlay.App.Shared/menu/{name}.webp. Alles andere ist ein 400 unter dem indizierten Schlüssel des Artikels, zum Beispiel menus[0].groups[1].items[2].imageUrl. Eine ausgelassene imageUrl entfernt das Bild, senden Sie also das gespeicherte zurück.
Lebenszyklus
- Für Menübilder gibt es keine Lösch-Route. Der Medienspeicher wird mit den Veranstaltungsbildern geteilt; ein Löschen auf der Menüseite könnte ein gespeichertes Veranstaltungsbild entfernen und die Tarifschranke der Veranstaltungs-Route umgehen. Gespeicherte Bilder bleiben außerdem für Gäste erreichbar, die noch eine zwischengespeicherte Seite haben (Medien-URLs werden ein Jahr zwischengespeichert).
- Ein Upload, der ersetzt, entfernt oder nie gespeichert wird, bleibt als Waise im Speicher; ein eigener Aufräumlauf räumt Waisen beider Arten ab.
- Die Menüs der Demo-Locations werden bei jedem Deployment zurückgesetzt; ein in ein Demo-Menü hochgeladenes Bild ist nach dem nächsten Release dort wieder weg.
Nächste Schritte
- Venue – die übrigen sechs Lesezugriffe dieser Location.
- QR-Codes und Tischsitzungen – die Bestellkarte des sitzenden Gastes, nicht diese Anzeigekarte.
- .NET-SDK – derselbe Lesezugriff als typisierte Methode.