Tổng quan

Hotspot API cung cấp danh sách khách đang lưu trú cho hệ thống hotspot (captive portal). Với mỗi khách đã nhận phòng và chưa trả phòng, HMS trả về số phòng, họ tên, số giấy tờ tùy thân, ngày sinh và thời điểm nhận/trả phòng. Phần mềm hotspot dùng danh sách này để xác minh đăng nhập Wi-Fi của khách bằng số phòng và họ, để đóng quyền truy cập khi kỳ lưu trú kết thúc, và để gắn nhật ký truy cập lưu theo Luật số 5651 của Thổ Nhĩ Kỳ với danh tính của khách.

URL gốc#

Endpoint nằm dưới URL gốc bên dưới, trong đường dẫn /public/json/…. Chỉ chấp nhận HTTPS.

URL gốc
https://test.hms.gen.tr

Tóm tắt luồng#

1KhóaApiKey
2Danh sáchPOST …/customer/inhotel
3Đối chiếuroomName + lastName
4Làm mớidiff by unique

Khóa được tạo một lần trong bảng quản trị HMS của khách sạn và được gửi trong header ApiKey ở mọi yêu cầu. Endpoint danh sách trả về tất cả khách đang lưu trú trong một lần gọi; phần mềm hotspot đối chiếu số phòng và họ mà khách nhập trên trang đăng nhập với danh sách này, mở tài khoản đến ngày trả phòng dự kiến, và làm mới danh sách theo chu kỳ để đóng tài khoản của những khách đã rời đi. Chi tiết có trong hướng dẫn Luồng xác minh khách.

Tài nguyên#

Tài nguyênEndpoint
Khách đang lưu trúPOST /public/json/customer/inhotel

Quy tắc chung#

  • Mọi yêu cầu đều mang header ApiKey. Không có bước đăng nhập và không có token.
  • Endpoint được gọi bằng POST; không có nội dung yêu cầu, chuỗi truy vấn hay tham số lọc.
  • Phản hồi ở dạng JSON và trường success là số 1 hoặc 0. Khi xác thực thất bại, API trả về HTTP 401 với {"success": 0}.
  • Thời gian là Unix timestamp (giây). Ngày sinh là chuỗi dạng DD.MM.YYYY.
  • Danh sách bao gồm toàn bộ khách sạn; không có bộ lọc theo phòng hay ngày. Hãy đối chiếu ở phía bạn và lưu danh sách vào bộ nhớ đệm.
  • Phản hồi chứa dữ liệu cá nhân (số giấy tờ tùy thân, ngày sinh). Chỉ lưu những trường bạn cần và gửi yêu cầu từ máy chủ của bạn, tuyệt đối không từ thiết bị của khách.

Quản lý phiên bản#

Endpoint này thuộc nhóm API tùy chỉnh của HMS và không có số phiên bản. Trường mới có thể được bổ sung mà không báo trước; hãy viết client sao cho bỏ qua các trường không xác định. Việc xóa một trường hiện có hoặc thay đổi ý nghĩa của trường sẽ được thông báo trước trong nhật ký thay đổi.

Bước tiếp theo#

Bắt đầu nhanhTạo khóa và lấy danh sách đầu tiên. Xác thựcHeader ApiKey và quản lý khóa. Luồng xác minh kháchĐối chiếu, thời hạn phiên, đồng bộ. Tham chiếu APICác trường, yêu cầu và phản hồi mẫu.
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