نظرة عامة
تزوّد Hotspot API نظامَ hotspot (بوابة تسجيل الدخول أو captive portal) بقائمة النزلاء المقيمين. فلكل نزيل سجّل وصوله ولم يغادر بعد، تعيد HMS رقم الغرفة والاسم ورقم الهوية وتاريخ الميلاد ووقتي الوصول والمغادرة. ويستخدم برنامج hotspot هذه القائمة للتحقق من دخول النزيل إلى شبكة Wi-Fi برقم الغرفة واسم العائلة، ولإغلاق الوصول عند انتهاء الإقامة، ولربط سجلات الوصول التي يحفظها وفق القانون التركي رقم 5651 بهوية محددة.
العنوان الأساسي#
تقع نقطة النهاية تحت العنوان الأساسي أدناه، على المسار /public/json/…. لا يُقبل إلا HTTPS.
https://test.hms.gen.trملخص المسار#
ApiKeyPOST …/customer/inhotelroomName + lastNamediff by uniqueيُنشأ المفتاح مرة واحدة في لوحة إدارة HMS الخاصة بالفندق، ويُرسَل في الترويسة ApiKey مع كل طلب. تعيد نقطة نهاية القائمة جميع النزلاء المقيمين في استدعاء واحد؛ ويطابق برنامج hotspot رقم الغرفة واسم العائلة اللذين يكتبهما النزيل في البوابة مع هذه القائمة، ويفتح الحساب حتى تاريخ المغادرة المخطط، ويحدّث القائمة على فترات منتظمة لإغلاق حسابات النزلاء الذين غادروا. التفاصيل في دليل مسار التحقق من النزلاء.
الموارد#
| المورد | نقاط النهاية |
|---|---|
| النزلاء المقيمون | POST /public/json/customer/inhotel |
قواعد عامة#
- يحمل كل طلب الترويسة
ApiKey. لا توجد خطوة لتسجيل الدخول ولا رمز مميز. - تُستدعى نقطة النهاية بالطريقة
POST، دون متن أو سلسلة استعلام أو معامل تصفية. - الاستجابات بتنسيق JSON، والحقل
successهو الرقم1أو0. وعند فشل المصادقة تُعاد حالة HTTP401مع{"success": 0}. - الأوقات طوابع زمنية Unix (بالثواني)، وتاريخ الميلاد سلسلة نصية بصيغة
DD.MM.YYYY. - تغطي القائمة الفندق كله، ولا توجد تصفية حسب الغرفة أو التاريخ. نفّذ المطابقة من جهتك وخزّن القائمة مؤقتًا.
- تحتوي الاستجابة على بيانات شخصية (رقم الهوية، وتاريخ الميلاد). لا تخزّن إلا الحقول التي تحتاج إليها، وأرسل الطلب من خادمك، لا من جهاز النزيل أبدًا.
الإصدارات#
تنتمي نقطة النهاية هذه إلى مجموعة واجهات API المخصصة في HMS، ولا تحمل رقم إصدار. قد تُضاف حقول جديدة دون إشعار مسبق؛ لذا صمّم عميلك بحيث يتجاهل الحقول التي لا يعرفها. أما حذف حقل موجود أو تغيير معناه فيُعلَن عنه مسبقًا في سجل التغييرات.