Tài liệu API
GoHost PMS Public API là API REST cho đối tác (website đặt phòng, chatbot, hệ thống của chuỗi) đọc dữ liệu cơ sở lưu trú và tạo, xác nhận, huỷ đặt phòng trực tiếp trên GoHost — không cần tài khoản người dùng PMS.
Khu này dành cho lập trình viên. Chủ cơ sở muốn kết nối một đối tác: liên hệ GoHost để được cấp API key (xem Xác thực & API key).
Thông tin chung
Phần tiêu đề “Thông tin chung”| Mục | Giá trị |
|---|---|
| Base URL | https://platform.gohost.vn/pms/api/public/v1 |
| Xác thực | Authorization: Bearer {api_key}:{api_secret} |
| Phạm vi một key | Mọi cơ sở (property) thuộc một tổ chức trên GoHost |
| Giới hạn mặc định | 60 request / phút / key |
| Định dạng | JSON; ngày YYYY-MM-DD, giờ HH:mm |
Đọc theo thứ tự
Phần tiêu đề “Đọc theo thứ tự”- Bắt đầu nhanh — từ lúc có key tới khi tạo được đặt phòng đầu tiên.
- Xác thực & API key — cách cấp key, header, phạm vi (scope), mã
tenant_id. - Giới hạn, phản hồi & mã lỗi — rate limit, cấu trúc JSON, phân trang, bảng mã lỗi.
- Webhook — nhận sự kiện đặt phòng, kiểm chữ ký, cơ chế gửi lại.
- Tham chiếu endpoint — tham số, body, phản hồi của từng endpoint (sinh từ đặc tả OpenAPI).
Endpoint theo nhóm
Phần tiêu đề “Endpoint theo nhóm”| Nhóm | Làm được gì | Scope |
|---|---|---|
| Property | Liệt kê cơ sở của tổ chức, tìm cơ sở còn phòng theo ngày | properties:read |
| Reference | Danh sách quốc gia, tỉnh/thành, phường/xã Việt Nam | properties:read |
| Room Type | Loại phòng, tìm loại phòng còn trống + giá | properties:read |
| Booking Source, Payment Method, Services | Nguồn đặt, phương thức thanh toán, dịch vụ của cơ sở | properties:read |
| Booking | Xem, tạo, xác nhận, thêm thanh toán, huỷ, cập nhật (check-in online) | bookings:read, bookings:write |
| Booking Rooms | Trả phòng, huỷ, đổi giá từng phòng trong đơn | bookings:write |
| Webhook | Đăng ký endpoint nhận sự kiện, xem lịch sử gửi | webhooks:read, webhooks:write |
Bài này có giúp được bạn không?
Cảm ơn bạn đã cho biết.
Chưa giúp được ở đâu?
Vui lòng không nhập tên, số điện thoại hay thông tin cá nhân của bạn hoặc của khách.
Cảm ơn bạn đã góp ý. CS dùng góp ý này để sửa bài.
Vẫn chưa xong việc?
Hỗ trợ trực tiếp 8:00–22:00 hằng ngày, kể cả cuối tuần.