نمای کلی

Hotspot API فهرست مهمانان مقیم هتل را در اختیار سیستم هات‌اسپات (captive portal) قرار می‌دهد. HMS برای هر مهمانی که چک‌این کرده و هنوز چک‌اوت نکرده است، شماره اتاق، نام، شماره شناسایی، تاریخ تولد و زمان‌های چک‌این و چک‌اوت را برمی‌گرداند. نرم‌افزار هات‌اسپات از این فهرست استفاده می‌کند تا ورود مهمان به وای‌فای را با شماره اتاق و نام خانوادگی تأیید کند، با پایان اقامت دسترسی را قطع کند و لاگ‌های دسترسی‌ای را که طبق قانون شماره 5651 ترکیه نگه می‌دارد به هویت مهمان پیوند دهد.

آدرس پایه#

این اندپوینت زیر آدرس پایه زیر و در مسیر /public/json/… قرار دارد. فقط HTTPS پذیرفته می‌شود.

آدرس پایه
https://test.hms.gen.tr

خلاصه جریان کار#

1کلیدApiKey
2فهرستPOST …/customer/inhotel
3تطبیقroomName + lastName
4به‌روزرسانیdiff by unique

کلید یک بار در پنل مدیریت HMS هتل ساخته می‌شود و در هر درخواست در هدر ApiKey ارسال می‌شود. اندپوینت فهرست، همه مهمانان مقیم را در یک فراخوانی برمی‌گرداند؛ نرم‌افزار هات‌اسپات شماره اتاق و نام خانوادگی‌ای را که مهمان در پورتال وارد می‌کند با این فهرست تطبیق می‌دهد، حساب را تا تاریخ برنامه‌ریزی‌شده چک‌اوت باز می‌کند و فهرست را در فواصل منظم به‌روز می‌کند تا حساب مهمانانی را که رفته‌اند ببندد. جزئیات در راهنمای جریان تأیید مهمان آمده است.

منابع#

منبعاندپوینت‌ها
مهمانان مقیمPOST /public/json/customer/inhotel

قواعد کلی#

  • هر درخواست هدر ApiKey را دارد. مرحله لاگین و توکنی در کار نیست.
  • اندپوینت با POST فراخوانی می‌شود؛ بدنه، رشته کوئری یا پارامتر فیلتری ندارد.
  • پاسخ‌ها JSON هستند و فیلد success عدد 1 یا 0 است. در صورت شکست احراز هویت، HTTP 401 همراه با {"success": 0} برمی‌گردد.
  • زمان‌ها مهر زمانی یونیکس (ثانیه) هستند. تاریخ تولد رشته‌ای به قالب DD.MM.YYYY است.
  • فهرست کل هتل را پوشش می‌دهد و فیلتری برای اتاق یا تاریخ ندارد. تطبیق را در سمت خودتان انجام دهید و فهرست را کش کنید.
  • پاسخ شامل داده‌های شخصی (شماره شناسایی، تاریخ تولد) است. فقط فیلدهای موردنیاز را ذخیره کنید و درخواست را از سرور خودتان بفرستید، هرگز از دستگاه مهمان.

نسخه‌بندی#

این اندپوینت به گروه API اختصاصی HMS تعلق دارد و شماره نسخه ندارد. فیلدهای جدید ممکن است بدون اطلاع قبلی اضافه شوند؛ کلاینت خود را طوری بنویسید که فیلدهای ناشناخته را نادیده بگیرد. حذف یک فیلد موجود یا تغییر معنای آن از قبل در یادداشت‌های انتشار اعلام می‌شود.

گام‌های بعدی#

شروع سریعکلید بسازید و اولین فهرست را دریافت کنید. احراز هویتهدر ApiKey و مدیریت کلیدها. جریان تأیید مهمانتطبیق، مدت نشست، همگام‌سازی. مرجع APIفیلدها، نمونه درخواست‌ها و پاسخ‌ها.
آخرین به‌روزرسانی: 21 سپتامبر 2026اشتباهی دیدید؟ به ما اطلاع دهید