ผู้เข้าพักในโรงแรม
ทรัพยากรเดียวของการเชื่อมต่อ Hotspot ส่งคืนข้อมูลห้อง ข้อมูลระบุตัวตน และข้อมูลเช็กอิน/เช็กเอาต์ของผู้เข้าพักทุกคนที่อยู่ในโรงแรมขณะนี้ (เช็กอินแล้วและยังไม่เช็กเอาต์) ซอฟต์แวร์ Hotspot จะดึงรายการนี้เป็นระยะและเปิดหรือปิดบัญชี Wi-Fi ตามนั้น ขั้นตอนต่าง ๆ อธิบายไว้ในคู่มือขั้นตอนการตรวจสอบผู้เข้าพัก
ออบเจ็กต์#
ฟิลด์
uniqueintegerID ของรายการเข้าพัก ไม่ซ้ำกันสำหรับผู้เข้าพักแต่ละคนและการจองแต่ละรายการ ใช้ค่านี้เป็นคีย์ผู้ใช้/เซสชันในฝั่ง Hotspot
rezervasyon_idintegerID การจอง ผู้เข้าพักที่อยู่ห้องเดียวกันจะมีค่านี้ร่วมกัน
inHotelinteger1 = ผู้เข้าพักอยู่ในโรงแรม ค่าจะเป็น 1 เสมอ เนื่องจากเอนด์พอยต์ส่งคืนเฉพาะผู้เข้าพักในโรงแรมเท่านั้นfirstNamestringชื่อ โดยทั่วไปเป็นตัวพิมพ์ใหญ่ตามที่อ่านจากเอกสารประจำตัว หากมีหลายชื่อจะคั่นด้วยช่องว่าง
lastNamestringนามสกุล โดยทั่วไปเป็นตัวพิมพ์ใหญ่
identityNumberstring | nullเลขประจำตัวประชาชนตุรกีหรือหมายเลขหนังสือเดินทางตามที่พิมพ์บนเอกสาร อาจว่างได้สำหรับผู้เข้าพักที่ลงทะเบียนโดยไม่มีข้อมูลเอกสารประจำตัว
birthDatestring | nullวันเกิด
DD.MM.YYYY อาจว่างได้roomIDintegerID ของห้องใน HMS
roomNamestringชื่อ/หมายเลขห้องตามที่ผู้เข้าพักเห็นบนประตูและคีย์การ์ด ให้ใช้ค่านี้เป็น “หมายเลขห้อง” ที่ถามบนพอร์ทัล
checkinintegerเวลาเช็กอินของผู้เข้าพักในรูปแบบ Unix timestamp (วินาที)
checkoutintegerวันเช็กเอาต์ตามแผนในรูปแบบ Unix timestamp ของเวลาเริ่มต้นวัน (00:00 UTC) โดยไม่มีข้อมูลเวลา ให้บวกเวลาเช็กเอาต์ของโรงแรม (โดยทั่วไป 12:00 น.) เพื่อหาเวลาสิ้นสุดเซสชัน
checkout2integer | nullเวลาเช็กเอาต์จริง เป็น
null สำหรับผู้เข้าพักในโรงแรม เพราะผู้เข้าพักที่เช็กเอาต์แล้วจะหายไปจากรายการอยู่แล้วmikrotikSifrelemeintegerการตั้งค่าการเข้ารหัส Mikrotik ใน HMS ของอาคารที่ห้องนั้นตั้งอยู่:
0 ชื่อห้อง (รหัสผ่าน Wi-Fi คือหมายเลขห้อง), 1 ไม่ใช้รหัสผ่าน ให้ใช้นโยบายเดียวกันบนพอร์ทัลของคุณ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
}รายชื่อผู้เข้าพักในโรงแรม#
POST
/public/json/customer/inhotelการยืนยันตัวตน: เฮดเดอร์ ApiKey
ส่งคืนรายชื่อผู้เข้าพักในโรงแรมทั้งหมด ไม่มีพารามิเตอร์ตัวกรองและไม่มีเนื้อหาคำขอ ผู้เข้าพักจะปรากฏในรายการเมื่อการจองอยู่ในสถานะใช้งาน เช็กอินแล้วและยังไม่เช็กเอาต์ และผู้เข้าพักถูกระบุสถานะว่า “อยู่ในโรงแรม” ผู้เข้าพักแต่ละคนในการจองเดียวกันจะเป็นรายการแยกกัน
การตอบกลับไม่มีการแบ่งหน้า โรงแรมขนาดใหญ่อาจส่งคืนหลายร้อยรายการ ให้แคชรายการไว้และรีเฟรชตามช่วงเวลาที่แนะนำ
เฮดเดอร์
ApiKeystringจำเป็นคีย์ API แบบกำหนดเองที่สร้างในแผงควบคุมผู้ดูแลของ HMS คีย์ผูกกับโรงแรมเดียว ซึ่งเป็นตัวกำหนดว่าจะแสดงผู้เข้าพักของโรงแรมใด
HotelCodeintegerID ของโรงแรมใน HMS ไม่ได้ใช้ในการตรวจสอบ เนื่องจากเซิร์ฟเวอร์ระบุโรงแรมจากคีย์ แนะนำให้ส่งเพื่อการบันทึก log และความเข้ากันได้
การตอบกลับ
200 success: 1 และอาร์เรย์ otelde หากไม่มีผู้เข้าพักในโรงแรม อาร์เรย์จะว่าง ซึ่งไม่ถือเป็นข้อผิดพลาด
successinteger1 สำเร็จ, 0 ไม่สำเร็จ เป็นค่าตัวเลข ไม่ใช่ boolean แบบใน Online Bookingotelde[]object[]รายการผู้เข้าพัก ดูฟิลด์ต่าง ๆ ได้ที่ส่วนออบเจ็กต์ด้านบน
การตอบกลับเมื่อเกิดข้อผิดพลาด
- 401 ไม่มีเฮดเดอร์
ApiKeyค่าว่าง หรือไม่พบคีย์ใน HMS (อาจถูกลบไปแล้ว) เนื้อหา:{"success": 0} - 405 คำขอใช้เมธอดอื่นที่ไม่ใช่
POST(เช่นGETจากแถบที่อยู่ของเบราว์เซอร์)
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
}