booking-client 1.0.0

Partner Connect API Service

Booking Python SDK 1.0.0

Welcome to the Booking SDK documentation. This guide will help you get started with integrating and using the Booking SDK in your project.

Versions

• API version: 1.0
• SDK version: 1.0.0

About the API

Partner Connect API Service

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • Access Token Authentication
  • API Key Authentication
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install booking-client

Authentication

Access Token Authentication

The Booking API uses an Access Token for authentication.

This token must be provided to authenticate your requests to the API.

Setting the Access Token

When you initialize the SDK, you can set the access token as follows:

Booking(
    access_token="YOUR_ACCESS_TOKEN",
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER"
)

If you need to set or update the access token after initializing the SDK, you can use:

sdk.set_access_token("YOUR_ACCESS_TOKEN")

API Key Authentication

The Booking API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.

Setting the API key

When you initialize the SDK, you can set the API key as follows:

Booking(
    access_token="YOUR_ACCESS_TOKEN",
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER"
)

If you need to set or update the API key after initializing the SDK, you can use:

sdk.set_api_key("YOUR_API_KEY", "YOUR_API_KEY_HEADER")

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:

Name
DemandApiV3CompatibleService
DemandApiV2CompatibleService

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:

Name	Description
SearchInputDto
ResponseOutputListSearchOutputDto
SearchAccept
DetailsInputDto
ResponseOutputListDetailsOutputDto
PostDetailsAccept
ConstantInputDto
ResponseOutputConstantsOutputDto
GetAccommodationConstantsAccept
ResponseOutputV2ReviewScoresOutputDto
ReviewScoresInputDto
GetHotelsReviewScoresAccept
ResponseOutputV2HotelsOutputDto
HotelsInputDto
GetHotelsAccept
ResponseOutputV2HotelTypesOutputDto
HotelTypeInputDto
GetHotelTypesAccept
ResponseOutputV2HotelThemeTypesOutputDto
HotelThemeTypeInputDto
GetHotelThemeTypesAccept
ResponseOutputV2HotelFacilityTypeOutputDto
HotelFacilityInputDto
GetRoomFacilityTypesAccept
ResponseOutputV2HotelAvailabilityOutputDto
HotelAvailabilityInputDto
GetHotelAvailabilityAccept
ResponseOutputV2BlockAvailabilityOutputDto
BlockAvailabilityInputDto
GetBlockAvailabilityAccept
BookerInputDto	The booker's information.
GuestsInputDto	The guest details for the request.
SearchInputDtoExtras	Input parameter to request for additional information about the products.
Coordinates	Limit the result list to the specified coordinates.
Platform	The booker platform for showing the platform based deals and prices.
TravelPurpose	The travel purpose of the booker.
UserGroups	The user groups that the booker is a member of.
AllocationInputDto	The exact allocation of guests to rooms.
SearchOutputDto
PriceDataDtoDouble	The price components of this product or selection of products. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
ProductDto
ExtraChargesDtoDouble	The charge breakdown. Includes taxes and fees.
PoliciesDto	The policies for this product.
PriceDataDtoListChargeDto	The price components of this product or selection of products. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
DealDto	This specifies the deal tagging for the product.
CancellationDto	The cancellation policy for this product.
MealPlanDto	The meal plan policy for this product.
PaymentDto	Payment terms and conditions for this product.
Type	The cancellation scheme supported by this product.
Meals	The meals included in the meal plan.
Plan	The meal plan included in this product.
PaymentTypes
ExtraChargesDtoListChargeDto	The charge breakdown. Includes taxes and fees.
ChargeDto
Mode
Tags
DetailsInputDtoExtras	Input parameter to request for additional information about the accommodation property. It should be passed as a JSON array with one or more items.
DetailsInputDtoLanguages	An IETF language tag code that uniquely identifies a supported human language or dialect as described here: https://en.wikipedia.org/wiki/IETF_language_tag. Note that in in demand-api-v3-compatible the whole tag is always lowercase. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US).
DetailsOutputDto
TranslatedString	Translated description of this room. The maximum number of characters returned may be limited by contract.
CheckinCheckoutTimesDto
ContactsDto	Contact information of the accommodation.
FacilityDto	The list of facilities available in this property. Requires {"extras":["facilities"]}.
DescriptionDto	Textual information about the accommodation. Requires {"extras":["description"]}.
KeyCollectionInformationDto
LocationDto	All location related information of this accommodation property.
PhotoDto
ProgramSettingsDto	Details of programmes undergone by the property.
RatingDto
RoomDto	The list of room types available at this property. Requires {"extras":["rooms"]}.
LocalTime	The time till when checkout can be done at this property.
ContactDto	Contact information of the accommodation. It can be null if the data is missing.
FacilityDtoAttributes	List of optional attributes for this facility.
TranslationInformation	Text containing important information about the property. The value is translated in the requested languages.
TruncatedString	The translated description text of this accommodation property in the requested languages. The maximum number of characters returned may be limited by contract.
AlternativeKeyLocationDto	Alternate location to collect the key of this accommodation property. This is returned if the key to access the property is in another location.
LazyTranslatedString	Translated accommodation address.
CoordinatesDto	A signed integer number that uniquely identifies a city.
PhotoUrlDto
StarsType	An enumerated value describing which type of stars this accommodation has.
RoomDtoAttributes	Lists a set of attribute qualifiers for this room. Will not be returned if no relevant attributes are applicable.
BedOptionDto	Lists all possible bedding options for this room or apartment.
CribsAndExtraBedsDto	Lists room options regarding adding cribs and/or extra beds.
RoomMaximumOccupancyDto	Occupancy limits and options.
NumberOfRoomsDto	Total rooms available.
BedConfigurationDto	Lists all alternative bed configurations that are supported.
BedDto	Detail list of all different types and number of beds included in this configuration.
Constants	Allows to filter the results only for specific sections.
ConstantInputDtoLanguages
Meta
ReviewScoresOutputDto
ScoreBreakdown	A breakdown of scores per reviewer type and review question.
ScoreDistribution	A breakdown of all review scores into buckets 1 - 10.
QuestionDto	Review scores per question.
ReviewScoresInputDtoLanguage	Code of the language used to render response. Please check the "Possible Values" section of the documentation for the accepted language codes.
ReviewerType	Limits reviews to those written by specific reviewer type.
HotelsOutputDto
HotelDataDto	Hotel specific information.
RoomDataDto	This block has room data for this hotel.
HotelPhotoDto	Photos specific information of the hotel.
RoomInfoDto
BedroomDto
RoomOccupancyDto
RoomSizeDto
HotelsInputDtoLanguage	The language code to return the results in. Please check the "Possible Values" section of the documentation for the accepted language codes.
HotelsInputDtoExtras	Returns extra bits of information about hotels.
HotelTypesOutputDto
TranslationDto
HotelTypeInputDtoLanguages	Limit the results to these languages. Please check the "Possible Values" section of the documentation for the accepted language codes.
HotelThemeTypesOutputDto
HotelFacilityTypeOutputDto
HotelFacilityInputDtoLanguages	Limit the results to these languages. Please check the "Possible Values" section of the documentation for the accepted language codes.
HotelAvailabilityOutputDto
HotelAvailabilityInputDtoUserPlatform	The user's platform.
BlockAvailabilityOutputDto
BlockOutputDto	The object containing all the relevant information for the combination of room, policy, meal and occupancy that determines the price." A block is the unique entity you book with booking.com.
BlockAvailabilityInputDtoExtras	The extra items for this request. See the documentation for more details about each extra.
BlockAvailabilityInputDtoLanguage	Specify the language for: block_id, policies, room texts and hotel descriptions. Note: not all text is translated in all languages. Please check the "Possible Values" section of the documentation for the accepted language codes.
BlockAvailabilityInputDtoUserPlatform	The user's platform.

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.