Ikhtisar
Hotspot API menyediakan daftar tamu yang sedang menginap untuk sistem hotspot (captive portal). Untuk setiap tamu yang sudah check-in dan belum check-out, HMS mengembalikan nomor kamar, nama, nomor identitas, tanggal lahir, serta waktu check-in/check-out. Perangkat lunak hotspot menggunakan daftar ini untuk memverifikasi login Wi-Fi tamu berdasarkan nomor kamar dan nama belakang, menutup akses saat masa menginap berakhir, dan mengaitkan log akses yang disimpannya sesuai Undang-Undang Turki No. 5651 dengan identitas tamu.
URL dasar#
Endpoint berada di bawah URL dasar berikut, pada path /public/json/…. Hanya HTTPS yang diterima.
https://test.hms.gen.trRingkasan alur#
ApiKeyPOST …/customer/inhotelroomName + lastNamediff by uniqueKunci dibuat sekali di panel admin HMS hotel dan dikirim sebagai header ApiKey pada setiap permintaan. Endpoint daftar mengembalikan semua tamu yang sedang menginap dalam satu panggilan; perangkat lunak hotspot mencocokkan nomor kamar dan nama belakang yang diketik tamu di portal dengan daftar ini, membuka akun hingga tanggal check-out yang direncanakan, dan memperbarui daftar secara berkala untuk menutup akun tamu yang sudah pergi. Detailnya ada di panduan Alur verifikasi tamu.
Sumber daya#
| Sumber daya | Endpoint |
|---|---|
| Tamu yang sedang menginap | POST /public/json/customer/inhotel |
Aturan umum#
- Setiap permintaan menyertakan header
ApiKey. Tidak ada langkah login dan tidak ada token. - Endpoint dipanggil dengan
POST; tidak ada body, query string, maupun parameter filter. - Respons berformat JSON dan field
successberupa angka1atau0. Kegagalan autentikasi mengembalikan HTTP401dengan{"success": 0}. - Waktu berupa Unix timestamp (detik). Tanggal lahir berupa string
DD.MM.YYYY. - Daftar mencakup seluruh hotel; tidak ada filter kamar atau tanggal. Lakukan pencocokan di sisi Anda dan simpan daftar di cache.
- Respons berisi data pribadi (nomor identitas, tanggal lahir). Simpan hanya field yang Anda perlukan dan kirim permintaan dari server Anda sendiri, jangan pernah dari perangkat tamu.
Versi#
Endpoint ini termasuk dalam grup API khusus HMS dan tidak memiliki nomor versi. Field baru dapat ditambahkan tanpa pemberitahuan; pastikan klien Anda mengabaikan field yang tidak dikenalnya. Penghapusan field yang ada atau perubahan maknanya diumumkan terlebih dahulu di catatan rilis.