Ospiti in hotel
L’unica risorsa dell’integrazione hotspot. Restituisce i dati di camera, identità e check-in/check-out di ogni ospite attualmente in hotel (check-in effettuato, check-out non ancora effettuato). Il software hotspot recupera questo elenco a intervalli regolari e apre o chiude di conseguenza gli account Wi-Fi; i passaggi sono descritti nella guida Flusso di verifica degli ospiti.
Oggetto#
Campi
uniqueintegerrezervasyon_idintegerinHotelinteger1 = l’ospite è in hotel. Vale sempre 1, perché l’endpoint restituisce solo gli ospiti in hotel.firstNamestringlastNamestringidentityNumberstring | nullbirthDatestring | nullDD.MM.YYYY. Può essere vuota.roomIDintegerroomNamestringcheckinintegercheckoutintegercheckout2integer | nullnull per gli ospiti in hotel; in ogni caso un ospite che effettua il check-out esce dall’elenco.mikrotikSifrelemeinteger0 nome della camera (la password del Wi-Fi è il numero di camera), 1 nessuna password. Applica lo stesso criterio nel tuo portale.01{
"mikrotikSifreleme": 0,
"unique": 58211,
"inHotel": 1,
"identityNumber": "11111111110",
"firstName": "AYŞE",
"lastName": "DEMİR",
"birthDate": "14.03.1985",
"roomID": 4,
"roomName": "104",
"checkin": 1788863400,
"checkout": 1788998400,
"checkout2": null,
"rezervasyon_id": 282799
}Elenco degli ospiti in hotel#
/public/json/customer/inhotelAutenticazione: Header ApiKey
Restituisce l’elenco completo degli ospiti in hotel. Non ci sono parametri di filtro né corpo della richiesta. Un ospite compare nell’elenco quando la prenotazione è attiva, il check-in è stato effettuato ma il check-out non ancora, e l’ospite è contrassegnato come “in hotel”. Ogni ospite della stessa prenotazione è un record separato.
La risposta non è paginata; gli hotel di grandi dimensioni possono restituire diverse centinaia di record. Metti in cache l’elenco e aggiornalo all’intervallo consigliato.
Header
ApiKeystringobbligatorioHotelCodeintegerRisposta
200 success: 1 e l’array otelde. Se non ci sono ospiti in hotel l’array è vuoto: non si tratta di un errore.
successinteger1 successo, 0 errore. È un numero, non un booleano come in Online Booking.otelde[]object[]Risposte di errore
- 401 Header
ApiKeymancante o vuoto, oppure chiave non definita in HMS (potrebbe essere stata eliminata). Corpo:{"success": 0}. - 405 La richiesta ha usato un metodo diverso da
POST(ad esempioGETdalla barra degli indirizzi del browser).
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"
}
});
const data = await res.json();$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',
],
]);
$data = json_decode(curl_exec($ch), true);{
"success": 1,
"otelde": [
{
"mikrotikSifreleme": 0,
"unique": 58211,
"inHotel": 1,
"identityNumber": "11111111110",
"firstName": "AYŞE",
"lastName": "DEMİR",
"birthDate": "14.03.1985",
"roomID": 4,
"roomName": "104",
"checkin": 1788863400,
"checkout": 1788998400,
"checkout2": null,
"rezervasyon_id": 282799
},
{
"mikrotikSifreleme": 0,
"unique": 58212,
"inHotel": 1,
"identityNumber": "22222222220",
"firstName": "MEHMET",
"lastName": "DEMİR",
"birthDate": "02.11.1982",
"roomID": 4,
"roomName": "104",
"checkin": 1788863400,
"checkout": 1788998400,
"checkout2": null,
"rezervasyon_id": 282799
},
{
"mikrotikSifreleme": 0,
"unique": 58197,
"inHotel": 1,
"identityNumber": "U01234567",
"firstName": "JULIA",
"lastName": "WAGNER",
"birthDate": "27.06.1990",
"roomID": 12,
"roomName": "205",
"checkin": 1788782700,
"checkout": 1789084800,
"checkout2": null,
"rezervasyon_id": 282803
}
]
}{
"success": 1,
"otelde": []
}{
"success": 0
}