Ikhtisar
Online Booking API menghubungkan booking engine di situs web hotel ke Perangkat Lunak Hotel HMS. Daftar kamar dan tarif, ketersediaan kalender, validasi kupon, langkah pembayaran, hingga pengiriman reservasi ke HMS semuanya berjalan melalui API ini. API ini dirancang untuk agensi yang membangun booking engine dan untuk mitra HMS.
URL dasar#
Semua endpoint berada di bawah URL dasar berikut, pada path /external/…. Hanya HTTPS yang diterima.
https://test.hms.gen.trAlur secara ringkas#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingToken dari login berlaku selama 7 hari dan terikat ke satu hotel. Daftar kamar mengembalikan kamar yang dapat dijual beserta harganya untuk tanggal dan jumlah tamu yang dicari tamu; setelah tamu memilih dan jenis pembayaran ditentukan, reservasi dicatat di HMS sebagai BookingPushRQ. Panduan Alur reservasi menjelaskan setiap langkahnya.
Sumber daya#
| Sumber daya | Endpoint |
|---|---|
| Autentikasi | POST /external/public/login |
| Kamar dan tarif | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| Reservasi | POST /external/online/channel/booking |
| Pembayaran | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| Kupon | POST /external/online/coupon/search |
| Paket dan ekstra | GET /external/stock/packages |
| Informasi hotel | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| Data acuan | POST /external/countiesGET /external/currenciesGET /external/languages |
Aturan umum#
- Setiap permintaan selain login menyertakan header
Authorization: Bearer <token>. - Sebagian besar endpoint
POSTmenerima field form (application/x-www-form-urlencodedataumultipart/form-data). Pengiriman reservasi dan langkah awal pembayaran mengharapkan body JSON. Halaman referensi setiap endpoint menyebutkan format yang digunakan. - Respons berformat JSON dengan penanda
success. Error aturan bisnis juga dikembalikan sebagai HTTP200; tentukan hasilnya berdasarkansuccess, bukan kode status. - Tanggal menggunakan format
YYYY-MM-DD, jumlah uang berupa string dengan dua angka desimal ("965.00"), dan mata uang mengikuti pengaturan channel online hotel. - Parameter
hotelIDharus sama dengan hotel yang terikat pada token.
Versi#
Dokumentasi ini mencakup HMS API V2. Field dan endpoint baru dapat ditambahkan tanpa pemberitahuan; pastikan klien Anda mengabaikan field yang tidak dikenal. Perubahan dicantumkan di catatan rilis.