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
Ein Event mit Tickets veranstalten
Ein Event anlegen und veröffentlichen, auf Ihrer Website zeigen, Anmeldungen oder bezahlte Stripe-Tickets annehmen, am Einlass einchecken und erstatten.
Die Events einer Location – ein Darts-Liga-Abend, eine Übertragung, ein Quiz – lassen sich auf Ihrer eigenen Website zeigen, nehmen kostenlose Anmeldungen mit Namenstickets entgegen oder verkaufen bezahlte Tickets über Stripe. Dieses Tutorial begleitet ein Event von der Konsole bis zur Tür: anlegen, veröffentlichen, auf eine Seite setzen, einen Gast Tickets kaufen lassen, sie einchecken und eines erstatten.
Events sind eine Pro-Funktion; der Online-Verkauf bezahlter Tickets ist Premium und braucht ein verbundenes Stripe-Auszahlungskonto (Abrechnung → Auszahlungen in der Konsole). Für die Seite brauchen Sie außerdem einen veröffentlichbaren Schlüssel (Authentifizierung).
1. Das Event anlegen
Öffnen Sie in der Konsole den Bereich Events und legen Sie ein Event an, oder bitten Sie Ihren Assistenten über MCP darum (events_create). Die Felder, auf die es ankommt:
| Feld | Was es bewirkt |
|---|---|
| Titel, Slug | Der Slug ist die Adresse des Events in der API (darts-league-night); lassen Sie ihn leer, um ihn aus dem Titel abzuleiten. Er wird einmal festgelegt |
| Beschreibung | Markdown, für Gäste gerendert. Eine Vorschau zeigt genau, was sie sehen werden |
| Datum, Beginn, Ende | In der Ortszeit der Location. Lassen Sie das Datum leer für ein fortlaufendes Event („Jeden Donnerstag“) und schreiben Sie die Angabe ins Zeitlabel |
| Anmeldemodus | None zeigt das Event nur an. Free gibt Namenstickets ohne Zahlung aus. Paid verkauft Tickets über Stripe Checkout |
| Kapazität, Tickets pro Anmeldung | Die Gesamtzahl der Tickets (leer ist unbegrenzt) und wie viele ein Gast auf einmal nehmen darf (Standard 6) |
| Anmeldung endet | Ein optionaler Zeitpunkt vor dem Beginn, nach dem keine Anmeldungen mehr angenommen werden |
| Ticketpreis, Währung | Nur bezahlte Events |
| Erstattungsregel | Nur bezahlte Events: keine Online-Erstattung oder volle Erstattung bis zu einer Stundenzahl vor Beginn (0 bis 720) |
Ein Event ist ein Entwurf, bis Sie es veröffentlichen; nur veröffentlichte Events werden gelistet. Veröffentlichen Sie es in der Konsole oder mit events_publish. Ein veröffentlichtes Event lässt sich absagen; das stoppt die Anmeldungen, lässt die Seite lesbar und kennzeichnet es als abgesagt.
2. Auf einer Seite zeigen
Am schnellsten geht es mit dem Widget. Es rendert die Karten, das Detail, das Anmeldeformular und die Ticketbestätigung, bei einem Paid-Event mit Stripe Checkout:
<div id="bookdineplay-events"></div>
<script src="https://cdn.bookdineplay.com/sdk/v1/bookdineplay.js"></script>
<script>
window.BookDinePlay.renderEventsWidget({
container: '#bookdineplay-events',
venueSlug: 'your-venue',
apiBaseUrl: 'https://api.bookdineplay.com',
publishableKey: 'bdp_pk_your_publishable_key',
layout: 'grid',
language: 'en'
});
</script>In WordPress ist dasselbe [bookdineplay_events venue="your-venue"], und [bookdineplay_event venue="your-venue" event="darts-league-night"] gibt einem Event eine eigene Seite. Ein Paid-Event sollte außerdem die Rücksprungadressen setzen (success_url und cancel_url am Shortcode), damit ein Gast nach Stripe auf Ihrer Website landet. Siehe Events-Widget und WordPress.
3. Eine eigene Event-Seite bauen
Für eigenes Markup lesen Sie die Liste und das Detail. Das Objekt registration des Details sagt, ob eine Anmeldung jetzt angenommen würde (open) und, wenn nicht, warum (reason):
curl
curl "https://api.bookdineplay.com/api/venues/your-venue/events/darts-league-night" \
-H "X-BookDinePlay-Key: bdp_pk_your_publishable_key" \
-H "Origin: https://www.your-venue.example"JavaScript
const event = await client.event('darts-league-night');
if (!event.registration.open) console.log(event.registration.reason); // closed, sold-out, past or not-openC#
var detail = await client.GetEventAsync("your-venue", "darts-league-night", cancellationToken);
Console.WriteLine($"{detail?.Registration.Open} {detail?.Registration.Remaining}");PHP
<?php
$response = wp_remote_get( 'https://api.bookdineplay.com/api/venues/your-venue/events/darts-league-night', [ 'headers' => [ 'X-BookDinePlay-Key' => BOOKDINEPLAY_SECRET_KEY ] ] );
$event = json_decode( wp_remote_retrieve_body( $response ), true );Fragen Sie höchstens so viele Tickets an, wie das Kleinere aus maxPerRegistration und remaining ergibt. Das Fenster kann sich zwischen Ihrem Lesen und der Anmeldung schließen; behandeln Sie also die Ablehnung ebenso wie das Flag.
4. Gäste anmelden
Für ein Free-Event melden Sie an: den Käufer und einen Namen pro Ticket. Sie erhalten eine Referenz, ein Ticket pro Teilnehmer und einen Stornolink, und der Gast eine E-Mail mit demselben:
curl
curl -X POST "https://api.bookdineplay.com/api/venues/your-venue/events/darts-league-night/registrations" \
-H "X-BookDinePlay-Key: bdp_pk_your_publishable_key" \
-H "Origin: https://www.your-venue.example" \
-H "Content-Type: application/json" \
-d '{ "buyerName": "Ada Lovelace", "email": "ada@example.com", "quantity": 2, "attendees": ["", "Grace Hopper"] }'JavaScript
const registration = await client.registerForEvent('darts-league-night', {
buyerName: 'Ada Lovelace', email: 'ada@example.com', quantity: 2, attendees: ['', 'Grace Hopper']
});
console.log(registration.reference, registration.tickets.map((t) => t.code));C#
var registration = await client.RegisterForEventAsync("your-venue", "darts-league-night",
new EventRegistrationRequest { BuyerName = "Ada Lovelace", Email = "ada@example.com", Quantity = 2, Attendees = ["", "Grace Hopper"] },
cancellationToken);PHP
<?php
$response = wp_remote_post( 'https://api.bookdineplay.com/api/venues/your-venue/events/darts-league-night/registrations', [
'headers' => [ 'X-BookDinePlay-Key' => BOOKDINEPLAY_SECRET_KEY, 'Content-Type' => 'application/json' ],
'body' => wp_json_encode( [ 'buyerName' => 'Ada Lovelace', 'email' => 'ada@example.com', 'quantity' => 2, 'attendees' => [ '', 'Grace Hopper' ] ] ),
] );
$registration = json_decode( wp_remote_retrieve_body( $response ), true );Ein leerer erster Teilnehmer bedeutet den Namen des Käufers. Die Plätze werden in dem Moment von der Kapazität abgezogen, in dem die Anmeldung angenommen wird; zwei Gäste, die um den letzten Platz konkurrieren, können ihn also nicht beide bekommen.
5. Bezahlte Tickets verkaufen
Bei einem Paid-Event geht derselbe Body stattdessen an die Checkout-Route, mit Rücksprungadressen. Sie gibt noch keine Tickets aus: Sie reserviert die Plätze, öffnet eine Stripe-Checkout-Sitzung auf dem eigenen Konto der Location und antwortet mit der checkoutUrl, an die der Gast geschickt wird:
curl
curl -X POST "https://api.bookdineplay.com/api/venues/your-venue/events/gala-night/tickets/checkout" \
-H "X-BookDinePlay-Key: bdp_pk_your_publishable_key" \
-H "Origin: https://www.your-venue.example" \
-H "Content-Type: application/json" \
-d '{ "buyerName": "Ada Lovelace", "email": "ada@example.com", "quantity": 2, "attendees": ["", "Grace Hopper"], "successUrl": "https://www.your-venue.example/event/gala-night?paid=1", "cancelUrl": "https://www.your-venue.example/event/gala-night?cancelled=1" }'JavaScript
const checkout = await client.checkoutEventTickets('gala-night', {
buyerName: 'Ada Lovelace', email: 'ada@example.com', quantity: 2, attendees: ['', 'Grace Hopper'],
successUrl: location.origin + '/event/gala-night?paid=1',
cancelUrl: location.origin + '/event/gala-night?cancelled=1'
});
window.location.assign(checkout.checkoutUrl);C#
var checkout = await client.CheckoutEventTicketsAsync("your-venue", "gala-night", new EventTicketCheckoutRequest
{
BuyerName = "Ada Lovelace",
Email = "ada@example.com",
Quantity = 2,
Attendees = ["", "Grace Hopper"],
SuccessUrl = "https://www.your-venue.example/event/gala-night?paid=1",
CancelUrl = "https://www.your-venue.example/event/gala-night?cancelled=1"
}, cancellationToken);PHP
<?php
$response = wp_remote_post( 'https://api.bookdineplay.com/api/venues/your-venue/events/gala-night/tickets/checkout', [
'headers' => [ 'X-BookDinePlay-Key' => BOOKDINEPLAY_SECRET_KEY, 'Content-Type' => 'application/json' ],
'body' => wp_json_encode( [
'buyerName' => 'Ada Lovelace', 'email' => 'ada@example.com', 'quantity' => 2, 'attendees' => [ '', 'Grace Hopper' ],
'successUrl' => 'https://www.your-venue.example/event/gala-night?paid=1', 'cancelUrl' => 'https://www.your-venue.example/event/gala-night?cancelled=1',
] ),
] );
$checkout = json_decode( wp_remote_retrieve_body( $response ), true );Die Rücksprungadressen müssen https sein und auf der Origin-Liste des Schlüssels stehen. Die Plätze bleiben reserviert, bis die Sitzung abläuft (expiresAt); bricht der Gast den Checkout ab, gehen sie wieder in den Verkauf. Senden Sie einen Idempotency-Key, damit eine wiederholte Anfrage denselben Checkout zurückgibt, statt Plätze doppelt zu reservieren. Ein Geschenkgutschein kann einen Teil der Tickets oder alle bezahlen (voucherCode); deckt er alles, öffnet sich keine Stripe-Seite, und die Tickets werden sofort ausgegeben (Gutscheine).
Fehlt eine der drei Bedingungen – Tarif, Auszahlungskonto, ein Paid-Event –, ist die Antwort absichtlich dieselbe 409 ticket-sales-not-enabled, damit ein Gast nie erfährt, welche es war.
6. Tickets und die Tür
Jedes Ticket hat einen 12-stelligen Code und eine Ticketseite mit einem QR-Code, der die Seitenadresse kodiert; der Gast behält die E-Mail oder die Seite. Keine der beiden Routen braucht einen Schlüssel:
curl "https://api.bookdineplay.com/api/tickets/<code>"Am Einlass öffnet ein Teammitglied in der Konsole das Einchecken des Events, gibt ein Ticket ein oder scannt es, und das Ticket wechselt mit Uhrzeit von Valid auf CheckedIn. Ein falscher Scan wird mit der Rückgängig-Aktion zurückgenommen (event_checkin und event_undo_checkin über MCP). Die Tickets eines abgesagten Events lesen sich weiter als Valid; prüfen Sie also auch den status des Events selbst.
7. Stornieren und erstatten
Die eigene Anmeldeseite des Gastes (GET /api/registrations/{cancelToken}) sagt, ob ein Storno gerade möglich ist (canCancel) und warum nicht (cancelNote): Das Ticket wurde eingecheckt, oder die Erstattungsregel erlaubt keine Online-Erstattung mehr. Bei einem bezahlten Event mit der Regel „volle Erstattung bis N Stunden vor Beginn“ erstattet ein Storno vor diesem Zeitpunkt auf die Karte; danach wird es mit refund-not-available abgelehnt, und die Anmeldung bleibt unberührt.
Die Location kann eine Anmeldung jederzeit aus der Konsole stornieren oder erstatten (event_registrations_cancel und event_registrations_refund), egal was die Regel sagt. Eine Erstattung bringt die Plätze wieder in den Verkauf und gibt einen Gutscheinanteil auf seinen Gutschein zurück. Weder die Ticketseite noch die Anmeldeseite noch der Stornolink sind tarifgebunden: Ein Gast behält sie nach einem Downgrade.
Nächste Schritte
- Events-API – jedes Feld, das Anmeldefenster und die Erstattungsregel im Detail.
- Events-Widget und WordPress – die fertige Oberfläche.
- Gutscheine – einen Geschenkgutschein für Tickets zahlen lassen.