Zum Hauptinhalt springen

Öffentliche Endpunkte

Alle Endpunkte verwenden https://api.my-playrooms.de/v1. Der vollständige maschinen- lesbare Vertrag steht unter /v1/openapi.json.

Katalog​

MethodePfadAuthentifizierungErgebnis
GET/v1/playroomsKeineArray von Playroom-Zusammenfassungen. currentPage wählt eine Seite; derzeit höchstens 20 Einträge ohne Pagination-Metadaten.
GET/v1/playrooms/{urlPath}KeineDetaillierte Playroom-Informationen.
GET/v1/playrooms/{urlPath}/booking-optionsKeineBuchbare Zeiten und Preise.

Orders​

MethodePfadAuthentifizierungErgebnis
POST/v1/ordersX-API-Key (bookings.create) und Idempotency-KeyErstellt eine Order und liefert orderId.
GET/v1/orders/{orderId}X-API-Key (bookings.read)Liefert die Order des API-Keys.
POST/v1/orders/{orderId}/paymentX-API-Key (bookings.payment.create)Erstellt eine gehostete Zahlungssitzung und liefert paymentUrl.

Die API erstellt Buchung und Zahlungssitzung, verarbeitet die Kartenzahlung aber nicht innerhalb des API-Requests. Der Gast bezahlt auf der gehosteten Zahlungsseite.

Fehler und Limits​

  • 400: Ungültige Anfrage oder fachlicher Validierungsfehler.
  • 401: Fehlender, ungültiger oder widerrufener API-Key.
  • 403: Gültiger API-Key ohne die nötige wirksame Berechtigung, siehe Schlüssel-Berechtigungen.
  • 409: POST /v1/orders mit einem Idempotency-Key, der mit einer anderen Anfrage verwendet wurde oder dessen früherer Versuch sich nicht als abgeschlossen bestätigen lässt. Wende dich an den Support, bevor du mit einem neuen Schlüssel wiederholst.
  • 404: Ressource oder Order nicht gefunden.
  • 429: Rate-Limit überschritten.
  • 500: Unerwarteter Serverfehler.

Anwendungsfehler verwenden normalerweise ProblemDetails mit title, status und detail. Verlasse dich nicht auf ein stabiles code-Feld. Einige unerwartete 500er verwenden noch ein älteres Fehlerformat; Clients sollten beide Formen verarbeiten.

Die öffentliche API erlaubt 200 Requests pro 60 Sekunden. Mit API-Key wird pro Key, sonst pro Client-IP begrenzt. Ein tägliches Limit ist nicht dokumentiert.

Webhooks​

Die öffentliche API bietet derzeit keine ausgehenden Buchungs-Webhooks. Frage den Status über GET /v1/orders/{orderId} ab. Stripe-Webhook-Endpunkte im Backend sind interne Zahlungsintegrationen und keine öffentlichen API-Endpunkte.