Pornire rapidă

Pe această pagină veți genera o cheie API în panoul HMS al hotelului și veți obține lista oaspeților cazați. Aveți nevoie de acces la panou cu un utilizator care are dreptul să gestioneze cheile API; în caz contrar, conducerea hotelului poate genera cheia și v-o poate transmite.

1. Generați o cheie#

• În panoul de administrare HMS, deschideți pagina API și treceți la fila Custom API.
• În câmpul de descriere, notați unde va fi folosită cheia (de ex. Hotspot – Clădirea principală) și salvați. HMS generează o cheie de 13 caractere.
• Copiați cheia din listă. Este legată de hotel și nu expiră; devine nevalidă în momentul în care este ștearsă din listă.

export HMS_API_KEY="017f1daf2d139"

Notați și ID-ul HMS al hotelului; exemplele îl trimit ca HotelCode: 1000. Antetul nu este folosit la validare, dar arată în jurnale ce hotel a fost interogat.

2. Obțineți lista#

Endpointul se apelează cu POST și nu primește corp:

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. Citiți răspunsul#

Fiecare oaspete cazat este o înregistrare separată în tabloul otelde. Un exemplu trunchiat pentru doi oaspeți care împart o cameră:

{
    "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 este unic pentru fiecare oaspete; asociați utilizatorul hotspot cu această valoare. rezervasyon_id este comun oaspeților din aceeași cameră.
• Numărul camerei cerut pe portal se compară cu roomName, iar numele de familie cu lastName. Valorile sunt de obicei scrise cu majuscule.
• checkin este momentul check-in-ului; checkout este data planificată de check-out (00:00 UTC), fără oră. Adăugați ora de check-out a hotelului pentru a obține sfârșitul sesiunii.
• Dacă nu este cazat nimeni, otelde este un tablou gol, iar success rămâne 1.

Ce urmează#

• Fluxul de verificare a oaspeților — reguli de potrivire, durata sesiunii, sincronizare periodică
• Autentificare — gestionarea cheilor și răspunsul 401
• Referință API — explicația fiecărui câmp