Overview

The Hotspot API feeds the in-house guest list to the hotspot (captive portal) system. For every guest who has checked in and not yet checked out, HMS returns the room number, name, ID number, date of birth and check-in/check-out times. The hotspot software uses the list to verify a guest’s Wi-Fi login by room number and surname, to close access when the stay ends, and to tie the access logs it keeps under Turkish Law 5651 to an identity.

Base URL#

The endpoint lives under the base URL below, on the /public/json/… path. Only HTTPS is accepted.

https://test.hms.gen.tr

Flow summary#

The key is generated once in the hotel’s HMS admin panel and sent as the ApiKey header on every request. The list endpoint returns all in-house guests in one call; the hotspot software matches the room number and surname the guest types on the portal against this list, opens the account until the planned check-out date, and refreshes the list at regular intervals to close accounts of guests who have left. The details are in the Guest verification flow guide.

Resources#

General rules#

• Every request carries the ApiKey header. There is no login step and no token.
• The endpoint is called with POST; there is no body, query string or filter parameter.
• Responses are JSON and the success field is the number 1 or 0. An authentication failure returns HTTP 401 with {"success": 0}.
• Times are Unix timestamps (seconds). The date of birth is a DD.MM.YYYY string.
• The list covers the whole hotel; there is no room or date filter. Match on your side and cache the list.
• The response contains personal data (ID number, date of birth). Store only the fields you need and send the request from your own server, never from the guest’s device.

Versioning#

This endpoint belongs to the HMS custom API group and carries no version number. New fields may be added without notice; write your client to ignore fields it does not know. Removing an existing field or changing its meaning is announced in advance in the changelog.

Next steps#