النزلاء المقيمون
المورد الوحيد في تكامل hotspot. يعيد بيانات الغرفة والهوية والوصول والمغادرة لكل نزيل مقيم حاليًا في الفندق (سجّل وصوله ولم يغادر بعد). يجلب برنامج hotspot هذه القائمة على فترات منتظمة ويفتح حسابات Wi-Fi أو يغلقها وفقًا لها؛ والخطوات مشروحة في دليل مسار التحقق من النزلاء.
الكائن#
الحقول
uniqueintegerمعرّف سجل الإقامة، فريد لكل نزيل وحجز. استخدمه مفتاحًا للمستخدم / الجلسة في نظام hotspot.
rezervasyon_idintegerمعرّف الحجز. يتشارك النزلاء المقيمون في الغرفة نفسها هذه القيمة.
inHotelinteger1 = النزيل مقيم في الفندق. القيمة دائمًا 1، لأن نقطة النهاية لا تعيد إلا النزلاء المقيمين.firstNamestringالاسم الأول. يكون عادةً بأحرف كبيرة كما قُرئ من وثيقة الهوية؛ وتُفصل الأسماء المتعددة بمسافة.
lastNamestringاسم العائلة. يكون عادةً بأحرف كبيرة.
identityNumberstring | nullرقم الهوية الوطنية التركية أو رقم جواز السفر كما هو مطبوع في الوثيقة. قد يكون فارغًا للنزلاء المسجلين دون بيانات هوية.
birthDatestring | nullتاريخ الميلاد،
DD.MM.YYYY. قد يكون فارغًا.roomIDintegerمعرّف الغرفة في HMS.
roomNamestringاسم الغرفة / رقمها كما يراه النزيل على الباب وبطاقة المفتاح. اطلبه في البوابة بوصفه «رقم الغرفة».
checkinintegerوقت تسجيل وصول النزيل كطابع زمني Unix (بالثواني).
checkoutintegerتاريخ المغادرة المخطط كطابع زمني Unix عند بداية اليوم (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. يرتبط بفندق واحد، وهو الذي يحدد الفندق الذي تُعرض قائمة نزلائه.
HotelCodeintegerمعرّف الفندق في HMS. لا يُستخدم في التحقق لأن الخادم يستنتج الفندق من المفتاح؛ ويُنصح بإرساله لأغراض التسجيل والتوافق.
الاستجابة
200 success: 1 والمصفوفة otelde. إذا لم يكن هناك نزلاء مقيمون تكون المصفوفة فارغة، وهذا ليس خطأً.
successinteger1 نجاح، 0 فشل. القيمة رقمية، وليست منطقية (boolean) كما في Online Booking.otelde[]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
}