Khách đang lưu trú

Tài nguyên duy nhất của tích hợp hotspot. Trả về thông tin phòng, nhận dạng và nhận/trả phòng của mọi khách hiện đang lưu trú (đã nhận phòng, chưa trả phòng). Phần mềm hotspot lấy danh sách này theo chu kỳ và mở hoặc đóng tài khoản Wi-Fi tương ứng; các bước được mô tả trong hướng dẫn Luồng xác minh khách.

POST/public/json/customer/inhotelDanh sách khách đang lưu trú

Đối tượng#

Các trường

uniqueinteger

ID bản ghi lưu trú, duy nhất cho mỗi khách và mỗi đặt phòng. Dùng giá trị này làm khóa người dùng / phiên ở phía hotspot.

rezervasyon_idinteger

ID đặt phòng. Các khách ở chung phòng có cùng giá trị này.

inHotelinteger

1 = khách đang lưu trú. Luôn là 1, vì endpoint chỉ trả về khách đang lưu trú.

firstNamestring

Tên. Thường viết hoa, theo cách đọc từ giấy tờ tùy thân; nếu có nhiều tên thì chúng được phân cách bằng dấu cách.

lastNamestring

Họ. Thường viết hoa.

identityNumberstring | null

Số định danh công dân Thổ Nhĩ Kỳ hoặc số hộ chiếu, đúng như in trên giấy tờ. Có thể trống với khách được đăng ký mà không có thông tin giấy tờ tùy thân.

birthDatestring | null

Ngày sinh, DD.MM.YYYY. Có thể trống.

roomIDinteger

ID HMS của phòng.

roomNamestring

Tên / số phòng như khách thấy trên cửa và thẻ khóa phòng. Hãy hỏi giá trị này dưới dạng “số phòng” trên trang đăng nhập.

checkininteger

Thời điểm khách nhận phòng, dạng Unix timestamp (giây).

checkoutinteger

Ngày trả phòng dự kiến, dạng Unix timestamp tại đầu ngày (00:00 UTC); không mang thông tin giờ. Cộng thêm giờ trả phòng của khách sạn (thường là 12:00) để có thời điểm kết thúc phiên.

checkout2integer | null

Thời điểm trả phòng thực tế. Là null với khách đang lưu trú; khách đã trả phòng sẽ tự động biến mất khỏi danh sách.

mikrotikSifrelemeinteger

Cài đặt mã hóa Mikrotik của tòa nhà chứa phòng trong HMS: 0 tên phòng (mật khẩu Wi-Fi là số phòng), 1 không có mật khẩu. Hãy áp dụng cùng chính sách trên trang đăng nhập của bạn.

01

Đối tượng mẫu

{
    "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
}

Danh sách khách đang lưu trú#

POST/public/json/customer/inhotel

Xác thực: Header ApiKey

Trả về toàn bộ danh sách khách đang lưu trú. Không có tham số lọc và không có nội dung yêu cầu. Một khách xuất hiện trong danh sách khi đặt phòng đang hoạt động, đã nhận phòng nhưng chưa trả phòng, và khách được đánh dấu là “đang lưu trú”. Mỗi khách trong cùng một đặt phòng là một bản ghi riêng.

Phản hồi không được phân trang; khách sạn lớn có thể trả về vài trăm bản ghi. Hãy lưu danh sách vào bộ nhớ đệm và làm mới theo chu kỳ khuyến nghị.

Header

ApiKeystringbắt buộc

Khóa API tùy chỉnh được tạo trong bảng quản trị HMS. Khóa gắn với một khách sạn, và chính khách sạn đó quyết định danh sách khách được trả về.

HotelCodeinteger

ID HMS của khách sạn. Không dùng để xác thực, vì máy chủ xác định khách sạn từ khóa; nên gửi để phục vụ ghi log và tương thích.

Phản hồi

200 success: 1 và mảng otelde. Nếu không có khách nào đang lưu trú, mảng sẽ rỗng; đó không phải là lỗi.

successinteger

1 thành công, 0 thất bại. Là số, không phải boolean như trong Online Booking.

otelde[]object[]

Các bản ghi khách. Xem mục Đối tượng ở trên để biết các trường.

Phản hồi lỗi

401 Header ApiKey bị thiếu, trống hoặc không tồn tại trong HMS (có thể đã bị xóa). Nội dung: {"success": 0}.
405 Yêu cầu dùng phương thức khác POST (ví dụ GET từ thanh địa chỉ của trình duyệt).

Yêu cầu

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);

Phản hồi · 200

{
    "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
        }
    ]
}

Phản hồi · 200 (không có khách đang lưu trú)

{
    "success": 1,
    "otelde": []
}

Phản hồi · 401 (khóa không hợp lệ)

{
    "success": 0
}

Cập nhật lần cuối: 21 tháng 9, 2026Phát hiện lỗi? Hãy cho chúng tôi biết