API Reference

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

FeatureMethodEndpointDescription
Query PropertiesGET/propertiesRetrieves a comprehensive list of properties along with their respective details.

Room Types

FeatureMethodEndpointDescription
Query Room TypesGET/room_typesFetches details and lists of room types available.

Reservations

FeatureMethodEndpointDescription
Query ReservationsGET/reservationsProvides detailed lookup of reservation information.
Create ReservationPOST/reservationsEnables direct creation of a new reservation in Hostex.

Availabilities

FeatureMethodEndpointDescription
Query Property AvailabilitiesGET/availabilitiesRetrieves availability information for properties for specified dates.
Update Property AvailabilitiesPOST/availabilitiesUpdates the availability status of properties.

Listing Calendar

FeatureMethodEndpointDescription
Query Listing CalendarsPOST/listings/calendarRetrieves detailed calendar information for multiple listings.
Update Listing InventoriesPOST/listings/inventoriesUpdates inventory levels for channel listings.
Update Listing PricesPOST/listings/pricesModifies listing prices for channel listings.
Update Listing RestrictionsPOST/listings/restrictionsAlters listing restrictions for channel listings.

Messaging

FeatureMethodEndpointDescription
Query ConversationsGET/conversationsRetrieves a list of guest conversations and inquiries.
Get Conversation DetailsGET/conversations/{conversation_id}Provides messages and conversation details.
Send MessagePOST/conversations/{conversation_id}Sends a text or image message to a guest.

Reviews

FeatureMethodEndpointDescription
Query ReviewsGET/reviewsQueries reviews akin to the Hostex Reviews Page.
Create a ReviewPOST/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.