Checkout API

Mit der Checkout API lösen Sie einen vollständigen CheckYout-Check-out aus Ihrem eigenen System aus — genau so, als hätte der Gast den QR-Code an der Tür gescannt. Der Aufruf startet die WhatsApp-Benachrichtigung an die Reinigungskraft, sendet E-Mail- und Webhook-Benachrichtigungen, fährt die Heizung in den Sparmodus (tado°, Netatmo, Vaillant, Nest), schaltet Lichter aus (Hue) und steuert Shelly-Geräte.

Wann nutzen?

Verwenden Sie diesen Endpoint, wenn Ihr System (z. B. Resavio, Smoobu Check-out, ein eigenes PMS) bereits erkennt, wann ein Gast die Unterkunft verlässt — etwa durch einen Online-Check-out, eine bezahlte Schlussrechnung oder einen manuellen Trigger durch den Gastgeber. Anstatt zusätzlich den QR-Code scannen zu lassen, übernimmt CheckYout direkt alle nachgelagerten Aktionen.

Endpoint

Request

Request-Body

Property-Mapping

Damit CheckYout weiß, welches Gerät zu welcher Resavio-Property gehört, muss der Gastgeber im CheckYout-Dashboard pro Unterkunft die Resavio-Property-ID unter Einstellungen → Resavio Property-ID hinterlegen. Anschließend genügt der Aufruf mit resavio_property_id.

Response

Erfolgsantwort (200)

{
  "success": true,
  "eventId": "8a4b1c2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
  "notified": true,
  "device_id": "ZNKKPJZV",
  "property_name": "Chalet Rösi"
}

Falls innerhalb der letzten 60 Sekunden bereits ein Check-out für dasselbe Gerät ausgelöst wurde, antwortet die API mit "eventId": "rate-limited" und "reason": "rate_limited" — das ist kein Fehler, nur ein Schutz vor Doppelauslösung.

Fehlerantworten

Code-Beispiele

curl -X POST https://checkyout.app/api/v1/checkout \
  -H "Content-Type: application/json" \
  -H "X-API-Key: cyo_IhrApiKey" \
  -d '{
    "resavio_property_id": "abc-123"
  }'

const response = await fetch('https://checkyout.app/api/v1/checkout', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': process.env.CHECKYOUT_API_KEY,
  },
  body: JSON.stringify({
    resavio_property_id: 'abc-123',
  }),
});

const data = await response.json();
console.log('Check-out ausgelöst:', data.eventId);

import requests
import os

response = requests.post(
    "https://checkyout.app/api/v1/checkout",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["CHECKYOUT_API_KEY"],
    },
    json={"resavio_property_id": "abc-123"},
)

response.raise_for_status()
data = response.json()
print(f"Check-out ausgelöst: {data['eventId']}")

<?php
$ch = curl_init('https://checkyout.app/api/v1/checkout');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-API-Key: ' . getenv('CHECKYOUT_API_KEY'),
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'resavio_property_id' => 'abc-123',
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);
echo $response;

Verhalten