Welcome to the Hostex API, where seamless integration meets comprehensive management of property and reservation systems. Our API provides a powerful suite of features for developers looking to automate and interact with the Hostex platform.
Quickstart
Get started with our API quickly by visiting our Quickstart Guide. This guide provides step-by-step instructions to make your first API call, authenticate successfully, and understand the basic operations.
API Version
- Current Version: 3.0.0 (Beta)
Please note that the current API version is in beta. We are actively developing and refining features to enhance functionality and performance. We appreciate any feedback or suggestions during this phase to help us improve the API.
Authentication
Each API request must be authenticated with a valid Hostex-Access-Token passed in the request header.
Key Functionalities
Our API supports a range of functionalities across various domains:
Properties
| Feature | Method | Endpoint | Description |
|---|---|---|---|
| Query Properties | GET | /properties | Retrieves a comprehensive list of properties along with their respective details. |
Room Types
| Feature | Method | Endpoint | Description |
|---|---|---|---|
| Query Room Types | GET | /room_types | Fetches details and lists of room types available. |
Reservations
| Feature | Method | Endpoint | Description |
|---|---|---|---|
| Query Reservations | GET | /reservations | Provides detailed lookup of reservation information. |
| Create Reservation | POST | /reservations | Enables direct creation of a new reservation in Hostex. |
Availabilities
| Feature | Method | Endpoint | Description |
|---|---|---|---|
| Query Property Availabilities | GET | /availabilities | Retrieves availability information for properties for specified dates. |
| Update Property Availabilities | POST | /availabilities | Updates the availability status of properties. |
Listing Calendar
| Feature | Method | Endpoint | Description |
|---|---|---|---|
| Query Listing Calendars | POST | /listings/calendar | Retrieves detailed calendar information for multiple listings. |
| Update Listing Inventories | POST | /listings/inventories | Updates inventory levels for channel listings. |
| Update Listing Prices | POST | /listings/prices | Modifies listing prices for channel listings. |
| Update Listing Restrictions | POST | /listings/restrictions | Alters listing restrictions for channel listings. |
Messaging
| Feature | Method | Endpoint | Description |
|---|---|---|---|
| Query Conversations | GET | /conversations | Retrieves a list of guest conversations and inquiries. |
| Get Conversation Details | GET | /conversations/{conversation_id} | Provides messages and conversation details. |
| Send Message | POST | /conversations/{conversation_id} | Sends a text or image message to a guest. |
Reviews
| Feature | Method | Endpoint | Description |
|---|---|---|---|
| Query Reviews | GET | /reviews | Queries reviews akin to the Hostex Reviews Page. |
| Create a Review | POST | /reviews/{reservation_code} | Submits a review or a reply for a specific reservation. |
Error Handling
Errors are communicated through request_id, error_code, and error_msg for clarity.
Response Format
All responses adhere to a standardized JSON format, ensuring a consistent and predictable API experience.
Webhooks
Leverage real-time notifications with webhooks. For usage details, visit the Webhooks Usage Guide.
For more detailed information on endpoint specifics, request structures, and operational guidance, please refer to our comprehensive API documentation.