Autentikasi

Hotspot API melakukan autentikasi dengan satu header HTTP: ApiKey. Tidak ada langkah login terpisah dan tidak ada token; kunci dikirim pada setiap permintaan.

Header#

POST /public/json/customer/inhotel HTTP/1.1
Host: test.hms.gen.tr
ApiKey: 017f1daf2d139
HotelCode: 1000
Content-Length: 0

Asal kunci#

Kunci dibuat di tab Custom API pada halaman API di panel admin HMS hotel. Kolom deskripsi digunakan untuk mencatat tempat kunci digunakan; beberapa kunci dapat dibuat sekaligus. Kunci yang dihapus di halaman yang sama langsung menjadi tidak valid.

Autentikasi gagal#

Jika header tidak ada atau kosong, atau kunci tidak ditemukan di HMS, respons berupa HTTP 401 dengan body berikut:

{
    "success": 0
}

Tidak ada detail error yang diberikan. Periksa dengan urutan berikut: nama header adalah ApiKey, nilainya persis sama dengan kunci yang disalin dari panel, dan kunci masih tercantum di panel. Jangan mengulang permintaan yang menghasilkan 401; hasilnya tidak akan berubah sampai kuncinya diperbaiki.

Konteks hotel#

Setiap kunci terikat ke satu hotel; respons hanya berisi tamu hotel tersebut. Untuk instalasi yang melayani beberapa hotel, dapatkan kunci dari panel masing-masing hotel dan simpan per hotel. Mengirim HotelCode yang berbeda tidak akan mengembalikan data hotel lain; kunci selalu menentukan hotelnya.

Melindungi kunci#

• Simpan kunci di konfigurasi server hotspot atau di variabel lingkungan; jangan pernah menaruhnya di HTML captive portal atau JavaScript sisi klien.
• Komponen yang mengambil daftar harus berjalan di sisi server. Perangkat tamu tidak boleh memanggil HMS secara langsung; respons berisi detail identitas semua tamu.
• Jika Anda menduga kunci telah bocor, hapus kunci tersebut di panel dan buat yang baru. Kunci lama langsung mengembalikan 401 begitu dihapus.