概览

Hotspot API 向热点（认证门户）系统提供在住客人名单。对于每位已入住且尚未退房的客人，HMS 会返回房间号、姓名、证件号码、出生日期以及入住/退房时间。热点软件利用该名单通过房间号和姓氏验证客人的 Wi-Fi 登录，在住宿结束时关闭访问权限，并将其按土耳其第 5651 号法律留存的访问日志与具体身份关联起来。

基础 URL#

该端点位于下方基础 URL 的 /public/json/… 路径下，仅支持 HTTPS。

https://test.hms.gen.tr

流程概要#

密钥在酒店的 HMS 管理后台中生成一次，之后每个请求都通过 ApiKey 请求头发送。名单端点一次调用即返回所有在住客人；热点软件将客人在认证门户上输入的房间号和姓氏与该名单进行匹配，为其开通账户直至计划退房日期，并定期刷新名单，以关闭已离店客人的账户。详细说明见客人验证流程指南。

资源#

通用规则#

• 每个请求都携带 ApiKey 请求头。没有登录步骤，也没有 token。
• 该端点使用 POST 调用；没有请求体、查询字符串或筛选参数。
• 响应为 JSON，success 字段为数字 1 或 0。身份验证失败时返回 HTTP 401 和 {"success": 0}。
• 时间为 Unix 时间戳（秒）。出生日期为 DD.MM.YYYY 格式的字符串。
• 名单涵盖整个酒店，不能按房间或日期筛选。请在您一方进行匹配，并缓存名单。
• 响应包含个人数据（证件号码、出生日期）。只存储您需要的字段，并从您自己的服务器发送请求，切勿从客人的设备发送。

版本管理#

该端点属于 HMS 自定义 API 组，没有版本号。新字段可能会在不另行通知的情况下加入；请让您的客户端忽略未知字段。删除现有字段或改变其含义，会提前在更新日志中公布。

后续步骤#