Skip to main content

Public API integration

Getting started​

1. Create an API key​

Sign in and create an API key under API keys in your account. Store it securely; the key is shown only once.

2. Make the first request​

curl -H "X-API-Key: YOUR_KEY" \
https://api.my-playrooms.de/v1/playrooms

The catalog endpoint is public. Add X-API-Key for order endpoints.

3. Process the response​

[
{
"id": "pl_123",
"urlPath": "lustspielzimmer",
"name": "Lustspielzimmer",
"city": "Berlin",
"rating": 4.8,
"ratingCount": 12,
"pricePerHour": 40,
"pricePerNight": 150
}
]

The catalog response is a direct JSON array, not a data envelope. The current page size is 20 and pagination metadata is not returned. Optional query parameters are locationSearchTerm, bookingType, checkInDate, guestCount and currentPage.

Create a payment session​

POST /v1/orders creates a booking and POST /v1/orders/{orderId}/payment creates a hosted payment session. The API does not perform the guest's card payment itself.

Rate limits​

  • 200 requests per 60 seconds for the public API
  • Per API key when X-API-Key is present, otherwise per client IP
  • No documented daily limit

Error handling​

CodeDescription
400Invalid request or domain validation error
401Missing, invalid or revoked API key
403Valid API key without the required effective permission
404Resource or order not found
409Idempotency-Key reused with a different request, or an earlier attempt could not be verified as complete
429Rate limit exceeded
500Unexpected server error

Application errors normally use RFC 7807 ProblemDetails with title, status, and detail. A stable code field is not part of the current contract.