نمای کلی
Online Booking API موتور رزرو وبسایت خود هتل را به نرمافزار هتلداری HMS متصل میکند. فهرست اتاقها و نرخها، تقویم ظرفیت، اعتبارسنجی کوپن، مرحله پرداخت و ارسال رزرو به HMS همگی از طریق این API انجام میشوند. این API برای آژانسهایی که موتور رزرو میسازند و برای شرکای تجاری HMS طراحی شده است.
آدرس پایه#
همه اندپوینتها زیر آدرس پایه زیر و در مسیر /external/… قرار دارند. فقط HTTPS پذیرفته میشود.
https://test.hms.gen.trجریان کار در یک نگاه#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingتوکنی که از لاگین میگیرید 7 روز معتبر است و به یک هتل وابسته است. فهرست اتاقها، اتاقها و قیمتهای قابل فروش را برای تاریخها و تعداد نفراتی که مهمان جستوجو کرده است برمیگرداند؛ پس از انتخاب مهمان و مشخص شدن روش پرداخت، رزرو بهصورت BookingPushRQ در HMS ثبت میشود. راهنمای جریان رزرو همه مراحل را گامبهگام شرح میدهد.
منابع#
| منبع | اندپوینتها |
|---|---|
| احراز هویت | POST /external/public/login |
| اتاقها و نرخها | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| رزرو | POST /external/online/channel/booking |
| پرداخت | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| کوپن | POST /external/online/coupon/search |
| پکیجها و خدمات اضافی | GET /external/stock/packages |
| اطلاعات هتل | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| دادههای پایه | POST /external/countiesGET /external/currenciesGET /external/languages |
قواعد کلی#
- همه درخواستها بهجز لاگین هدر
Authorization: Bearer <token>را دارند. - بیشتر اندپوینتهای
POSTفیلدهای فرم (application/x-www-form-urlencodedیاmultipart/form-data) میگیرند. ارسال رزرو و شروع پرداخت بدنه JSON میخواهند. صفحه مرجع هر اندپوینت قالب آن را مشخص میکند. - پاسخها JSON هستند و فیلد
successدارند. خطاهای منطق کسبوکار هم با HTTP200برمیگردند؛ نتیجه را بر اساسsuccessبسنجید، نه کد وضعیت. - تاریخها به قالب
YYYY-MM-DDو مبالغ رشتههایی با دو رقم اعشار ("965.00") هستند؛ ارز از تنظیمات کانال آنلاین هتل تعیین میشود. - پارامتر
hotelIDباید با هتلی که توکن به آن وابسته است یکسان باشد.
نسخه#
این مستندات نسخه V2 از HMS API را پوشش میدهند. فیلدها و اندپوینتهای جدید ممکن است بدون اطلاع قبلی اضافه شوند؛ کلاینت خود را طوری بنویسید که فیلدهای ناشناخته را نادیده بگیرد. تغییرات در یادداشتهای انتشار فهرست میشوند.