Snelstart

Op deze pagina maak je een API-sleutel aan in het HMS-beheerpaneel van het hotel en haal je de lijst met aanwezige gasten op. Je hebt toegang tot het beheerpaneel nodig met een gebruiker die API-sleutels mag beheren; anders kan het hotelmanagement de sleutel aanmaken en aan je doorgeven.

1. Sleutel aanmaken#

• Open in het HMS-beheerpaneel de pagina API en ga naar het tabblad Custom API.
• Vul in het beschrijvingsveld in waar de sleutel wordt gebruikt (bijv. Hotspot – Hoofdgebouw) en sla op. HMS maakt een sleutel van 13 tekens aan.
• Kopieer de sleutel uit de lijst. Hij is gebonden aan het hotel en verloopt niet; zodra hij uit de lijst wordt verwijderd, is hij ongeldig.

export HMS_API_KEY="017f1daf2d139"

Noteer ook de HMS-ID van het hotel; de voorbeelden sturen die mee als HotelCode: 1000. De header wordt niet gebruikt voor validatie, maar laat in logs zien welk hotel is opgevraagd.

2. De lijst ophalen#

Het endpoint wordt aangeroepen met POST en verwacht geen body:

curl -X POST "https://test.hms.gen.tr/public/json/customer/inhotel" \
  -H "ApiKey: $HMS_API_KEY" \
  -H "HotelCode: 1000"

const res = await fetch("https://test.hms.gen.tr/public/json/customer/inhotel", {
  method: "POST",
  headers: {
    "ApiKey": process.env.HMS_API_KEY,
    "HotelCode": "1000"
  }
});
if (res.status === 401) throw new Error("Invalid ApiKey");
const data = await res.json();
for (const g of data.otelde) {
  console.log(g.roomName, g.firstName, g.lastName, new Date(g.checkout * 1000));
}

$ch = curl_init('https://test.hms.gen.tr/public/json/customer/inhotel');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_HTTPHEADER     => [
        'ApiKey: ' . getenv('HMS_API_KEY'),
        'HotelCode: 1000',
    ],
]);
$body = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) === 401) {
    throw new RuntimeException('Invalid ApiKey');
}
$data = json_decode($body, true);
foreach ($data['otelde'] as $g) {
    echo $g['roomName'], ' · ', $g['firstName'], ' ', $g['lastName'], ' · ', date('d.m.Y', $g['checkout']), "\n";
}

3. Het antwoord lezen#

Elke aanwezige gast is een apart record in de array otelde. Een ingekort voorbeeld voor twee gasten die een kamer delen:

{
    "success": 1,
    "otelde": [
        {
            "unique": 58211,
            "firstName": "AYŞE",
            "lastName": "DEMİR",
            "identityNumber": "11111111110",
            "birthDate": "14.03.1985",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "rezervasyon_id": 282799
        },
        {
            "unique": 58212,
            "firstName": "MEHMET",
            "lastName": "DEMİR",
            "identityNumber": "22222222220",
            "birthDate": "02.11.1982",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "rezervasyon_id": 282799
        }
    ]
}

• unique is uniek per gast; koppel de hotspotgebruiker hieraan. rezervasyon_id is gelijk voor gasten in dezelfde kamer.
• Het kamernummer dat op het portal wordt gevraagd, vergelijk je met roomName, de achternaam met lastName. Waarden staan meestal in hoofdletters.
• checkin is het moment van inchecken; checkout is de geplande uitcheckdatum (00:00 UTC) zonder tijdstip. Tel de uitchecktijd van het hotel erbij op voor het einde van de sessie.
• Is er niemand aanwezig, dan is otelde een lege array en is success nog steeds 1.

Hoe verder#

• Gastverificatieflow — matchregels, sessieduur, periodieke synchronisatie
• Authenticatie — sleutelbeheer en het 401-antwoord
• API-referentie — alle velden toegelicht