مهمانان مقیم
تنها منبع یکپارچهسازی هاتاسپات. اطلاعات اتاق، هویت و چکاین/چکاوت را برای همه مهمانانی که هماکنون در هتل مقیماند (چکاین کردهاند و هنوز چکاوت نکردهاند) برمیگرداند. نرمافزار هاتاسپات این فهرست را در فواصل منظم دریافت میکند و بر اساس آن حسابهای وایفای را باز یا بسته میکند؛ مراحل در راهنمای جریان تأیید مهمان شرح داده شده است.
شیء#
فیلدها
uniqueintegerشناسه رکورد اقامت؛ برای هر مهمان و رزرو یکتاست. در سمت هاتاسپات از آن بهعنوان کلید کاربر / نشست استفاده کنید.
rezervasyon_idintegerشناسه رزرو. مهمانانی که در یک اتاق اقامت دارند، این مقدار مشترک را دارند.
inHotelinteger1 = مهمان در هتل مقیم است. همیشه 1 است، چون اندپوینت فقط مهمانان مقیم را برمیگرداند.firstNamestringنام. معمولاً با حروف بزرگ، همانطور که از مدرک شناسایی خوانده شده است؛ چند نام با فاصله از هم جدا میشوند.
lastNamestringنام خانوادگی. معمولاً با حروف بزرگ.
identityNumberstring | nullشماره ملی ترکیه یا شماره گذرنامه، همانطور که روی مدرک درج شده است. برای مهمانانی که بدون اطلاعات هویتی ثبت شدهاند ممکن است خالی باشد.
birthDatestring | nullتاریخ تولد،
DD.MM.YYYY. ممکن است خالی باشد.roomIDintegerشناسه اتاق در HMS.
roomNamestringنام / شماره اتاق، همانطور که مهمان روی در و کارت کلید میبیند. در پورتال همین را بهعنوان «شماره اتاق» بپرسید.
checkinintegerزمان چکاین مهمان بهصورت مهر زمانی یونیکس (ثانیه).
checkoutintegerتاریخ برنامهریزیشده چکاوت بهصورت مهر زمانی یونیکس در ابتدای روز (00:00 UTC)؛ ساعتی از روز را در بر ندارد. برای به دست آوردن پایان نشست، ساعت چکاوت هتل (معمولاً 12:00) را به آن اضافه کنید.
checkout2integer | nullزمان واقعی چکاوت. برای مهمانان مقیم
null است؛ مهمانی که چکاوت کند در هر صورت از فهرست حذف میشود.mikrotikSifrelemeintegerتنظیم رمزگذاری Mikrotik ساختمان اتاق در HMS:
0 نام اتاق (رمز وایفای همان شماره اتاق است)، 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 ناموفق. برخلاف Online Booking، عدد است نه boolean.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
}