diff --git a/.gitbook.yaml b/.gitbook.yaml index f7c54ba..278d3c3 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -1,10 +1,7 @@ root: ./ -structure: - readme: README.md - summary: SUMMARY.md - redirects: booking-engine-guide/booking-engine-widget/integrations: integrations/README.md booking-engine-guide/booking-engine-widget/integrations/google-tag-manager: integrations/google-tag-manager.md booking-engine-guide/booking-engine-widget/integrations/google-triggers-reference: integrations/google-triggers-reference.md + booking-engine-api/guidelines/authorization: booking-engine-api/guidelines/authentication.md diff --git a/FAQ/mews-li-migration.md b/FAQ/mews-li-migration.md index c9f07f6..de526cc 100644 --- a/FAQ/mews-li-migration.md +++ b/FAQ/mews-li-migration.md @@ -1,6 +1,8 @@ -# How to migrate booking engine off mews.li +# Migration off the mews.li domain -> ⚠️ Support for this outdated implementation was discontinued as of May 1 - we are not responsible for the functionality of the booking engine on this domain +This is a guide to help you migrate your booking engine off the discontinued `mews.li` domain. + +> **Important:** Support for the old domain was discontinued in May 2024 - we are not responsible for the functionality of the booking engine on this domain. ## Standalone Booking Engine migration @@ -39,4 +41,4 @@ Replace the domain in your booking engine loading script from `https://mews.li` ``` After a successful migration, the keyword `mews.li` should no longer appear on your website. -If you have any questions, please open a ticket from Mews Operations via our Mews Digital Assistant. +If you have any questions, please open a ticket from __Mews Operations__ via the Mews Digital Assistant. diff --git a/SUMMARY.md b/SUMMARY.md index 8ac449b..176a387 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -16,11 +16,11 @@ * [Reference](booking-engine-widget/reference.md) * [Troubleshooting](booking-engine-widget/troubleshooting.md) * [Booking Engine API](booking-engine-api/README.md) - * [Guidelines](booking-engine-api/guidelines/README.md) + * [Usage guidelines](booking-engine-api/guidelines/README.md) + * [Authentication](booking-engine-api/guidelines/authentication.md) * [Requests](booking-engine-api/guidelines/requests.md) * [Responses](booking-engine-api/guidelines/responses.md) * [Environments](booking-engine-api/guidelines/environments.md) - * [Authorization](booking-engine-api/guidelines/authorization.md) * [Images](booking-engine-api/guidelines/images.md) * [Supported currency codes](booking-engine-api/guidelines/supported-currency-codes.md) * [Supported language codes](booking-engine-api/guidelines/supported-language-codes.md) @@ -42,12 +42,13 @@ * [Integrations](integrations/README.md) * [Google Tag Manager](integrations/google-tag-manager.md) * [Google Triggers Reference](integrations/google-triggers-reference.md) - * [Google Tag Manager - Configuration](integrations/gtm-skeleton.md) + * [Google Tag Manager Configuration](integrations/gtm-skeleton.md) * [Google Analytics cross-domain tracking](integrations/ga-cross-domain-tracking.md) * [FAQ](FAQ/README.md) * [Ways to integrate](FAQ/ways-to-integrate.md) * [Migration off the mews.li domain](FAQ/mews-li-migration.md) * [Changelog](changelog/README.md) + * [Changelog 2024](changelog/changelog2024.md) * [Changelog 2023](changelog/changelog2023.md) * [Changelog 2022](changelog/changelog2022.md) * [Changelog 2021](changelog/changelog2021.md) diff --git a/booking-engine-api/README.md b/booking-engine-api/README.md index c29c6ed..91d6f1e 100644 --- a/booking-engine-api/README.md +++ b/booking-engine-api/README.md @@ -7,7 +7,7 @@ Use this option if you want to create your own custom booking engine. > We maintain an [OpenAPI definition](https://api.mews.com/swagger/distributor/swagger.json) (formerly Swagger) for the __Mews Booking Engine API__. You can use this to build out client applications using third party tools. > At this stage we consider this a Beta test version, but please use it and get in touch to let us know how you get on. -* [Guidelines](guidelines/README.md) +* [Usage guidelines](guidelines/README.md) * [Use cases](use-cases/README.md) * [API Operations](operations/README.md) * [Deprecations](deprecations/README.md) diff --git a/booking-engine-api/deprecations/README.md b/booking-engine-api/deprecations/README.md index 17c9681..e29a127 100644 --- a/booking-engine-api/deprecations/README.md +++ b/booking-engine-api/deprecations/README.md @@ -1,9 +1,8 @@ # Deprecations -Deprecations are features of the API which you are discouraged from using, even though they may still be supported for a period of time for the sake of backwards compatibility. -Such features are normally deprecated because they are superseded by a better alternative. They can include object properties or entire API operations. -The list of deprecations is as follows. Individual items are also highlighted in the [Changelog](../../changelog/README.md) when they occur. -Historic deprecations that have already been discontinued may not be listed. For more information, see our [Deprecations Policy](https://mews-systems.gitbook.io/open-api/staying-up-to-date/deprecations-policy). +Deprecations are features of the API which you are discouraged from using, even though they may still be supported for a period of time for the sake of backwards compatibility. Such features are normally deprecated because they are superseded by a better alternative. They can include object properties or entire API operations. The list of deprecations is as follows. Individual items are also highlighted in the [Changelog](../../changelog/README.md) when they occur. Historic deprecations that have already been discontinued may not be listed. + +**For more information, see our [Deprecations Policy](https://mews-systems.gitbook.io/open-api/staying-up-to-date/deprecations-policy).** > **Important:** We strongly advise you to review this list and if you are using any of the deprecated items in your integration, to update your implementation accordingly. @@ -14,7 +13,7 @@ The table columns have the following meanings: * __Replaced by__ \- What the replacement is, if applicable * __Context__ \- The context in which the property is used, usually the API operation * __Deprecated__ \- The date at which the deprecation notice was given (see the [Changelog](../../changelog/README.md)) -* __Discontinued__ \- The date at which it is planned to discontinue support completely; a value of '-' indicates no date has been set +* __Discontinued__ \- The date at which it is planned to discontinue the feature completely; a value of '-' indicates no date has been set ## Deprecated object properties diff --git a/booking-engine-api/guidelines/README.md b/booking-engine-api/guidelines/README.md index f89d7f0..c5c72ba 100644 --- a/booking-engine-api/guidelines/README.md +++ b/booking-engine-api/guidelines/README.md @@ -1,13 +1,13 @@ -# Guidelines +# Usage guidelines This section provides guidelines and general information on how to use the __Mews Booking Engine API__. For information about individual endpoints or operations, see [API Operations](../operations/README.md). > **Important:** The Mews Booking Engine API is designed to be consumed directly by front-end clients. It is unsuitable for continuous polling by a single server due to its built-in anti-scraping protection and such requests can fail. For server to server communication, please refer to the [Mews Connector API](https://mews-systems.gitbook.io/connector-api/). +* [Authentication](authentication.md) * [Requests](requests.md) * [Responses](responses.md) * [Environments](environments.md) -* [Authorization](authorization.md) * [Images](images.md) * [Supported currency codes](supported-currency-codes.md) * [Supported language codes](supported-language-codes.md) diff --git a/booking-engine-api/guidelines/authentication.md b/booking-engine-api/guidelines/authentication.md new file mode 100644 index 0000000..abc084c --- /dev/null +++ b/booking-engine-api/guidelines/authentication.md @@ -0,0 +1,36 @@ +# Authentication + +The __Mews Booking Engine API__ is a public API that requires client authentication and authorization. + +## Client authentication + +Authentication is the process of verifying the identity of the client. To access the API, you must identify your client application by providing the `Client` property in all requests. This ensures that your client application is recognized and allowed to interact with the API. + +### Pre-registered + +Your client application needs to be pre-registered with Mews Support. You can open a ticket from __Mews Operations__ via the Mews Digital Assistant. The registration request should contain: + +* `Client` - the name of the client application that will be used for every API request +* `Email` - an email contact for your development department; this email will be used by our developers to notify you about any breaking changes in the API +* `Environment` - the name of the environment you are accessing, either `Production` or `Demo`. + +### Environments + +We offer two environments, `Production` and `Demo`. Use `Demo` during API implementation, and `Production` only for live customer sites. +The two environments have separate client lists, so make sure you are registered in `Production` before you move your implementation to the Production environment. +For details, see our [Environments](environments.md) page. + +### Sample client name + +Before the registration of your `Client` name is confirmed, you can use the sample client name below. This client name will **only work in the Demo environment**. +Keep in mind that this must be replaced by your proper `Client` name as soon as you finish the registration process. + +```json +{ + "Client": "My Client 1.0.0" +} +``` + +## Client authorization + +Authorization is the process of determining what the authenticated client is allowed to do. In this case, it is sufficient to know the unique identifier of a hotel or other enterprise in order to access it. However, the client must be authenticated by providing the `Client` property in all requests to ensure it has the necessary permissions to interact with the API. diff --git a/booking-engine-api/guidelines/authorization.md b/booking-engine-api/guidelines/authorization.md deleted file mode 100644 index fdf798c..0000000 --- a/booking-engine-api/guidelines/authorization.md +++ /dev/null @@ -1,20 +0,0 @@ -# Authorization - -The Mews Booking Engine API is a public API with client name authorization. It is sufficient to know the unique identifier of a hotel in order to access it, however it is required that the client identify itself by providing the `Client` property in all requests made to the API. - -The Client application needs to be pre-registered with the Mews Support. You can open a ticket from Mews Operations via our Mews Digital Assistant. The registration request should contain: - -* `Client` - the name of the client that will be used for every API request -* `Email` - an email contact for the client's tech/dev department; this email will be used by our developers in order to notify you about any breaking changes in the API -* `Environments` - we offer two [Environments](./environments.md), `Production` and `Demo`, where `Demo` should be used during API implementation. **Note:** the two environments have separate client lists, so make sure you are registered in `Production` before you move your implementation to the Production environment. - -> **Sample Client name** -> -> Before the registration of your Client name is confirmed, you can use the sample Client name below. This Client name will **only work in the Demo environment**. -> Keep in mind that this must be replaced by your proper Client name as soon as you finish the registration process. -> ->```json ->{ -> "Client": "My Client 1.0.0" ->} ->``` diff --git a/booking-engine-api/guidelines/environments.md b/booking-engine-api/guidelines/environments.md index 7604b74..b189038 100644 --- a/booking-engine-api/guidelines/environments.md +++ b/booking-engine-api/guidelines/environments.md @@ -23,6 +23,6 @@ This is the live production environment. * **Hotel Id** - This depends on the hotel and should be provided to you by the hotel administrator. * **Configuration Id** - This depends on the hotel setup and can be found in **Mews Operations** administration. -## Whitelisting +## IP address allowlisting -Whitelisting (also called 'allowlisting') is a common security measure which can be applied to a system to allow only specified external systems to talk to it. This has traditionally been achieved using IP address-based firewall rules. However, this approach does not work with modern cloud based architectures, which use dynamic and shared IP addresses, proxy servers and elastic resources. For this reason, we do not support the use of IP address whitelists for our APIs and we cannot supply a list of IP addresses for our APIs. +Allowlisting (formerly 'whitelisting') is a common security measure which can be applied to a system to allow only specified external systems to talk to it. This has traditionally been achieved using IP address-based firewall rules. However, this approach does not work with modern cloud based architectures, which use dynamic and shared IP addresses, proxy servers and elastic resources. For this reason, we do not support the use of IP address allowlists for our APIs and we cannot supply a list of IP addresses for our APIs. diff --git a/booking-engine-api/guidelines/requests.md b/booking-engine-api/guidelines/requests.md index 11d16e3..1f52d8a 100644 --- a/booking-engine-api/guidelines/requests.md +++ b/booking-engine-api/guidelines/requests.md @@ -22,11 +22,11 @@ The API accepts only `HTTP POST` requests with `Content-Type` set to `applicatio "CultureCode": null } ``` -| Property | Type | Contract | Description | -|:---------------|:-------|:---------|:---------------------------------------------------------------------------------| -| `Client` | string | required | Identification of the Client as described in [Authorization](./authorization.md) | -| `LanguageCode` | string | optional | Code of the language. [Supported language codes](./supported-language-codes.md) | -| `CultureCode` | string | optional | Code of the culture | +| Property | Type | Contract | Description | +|:--|:--|:--|:--| +| `Client` | string | required | Identification of the client, as described in [Authentication](./authentication.md). | +| `LanguageCode` | string | optional | Code of the language, see [Supported language codes](./supported-language-codes.md). | +| `CultureCode` | string | optional | Code of the culture, see [Supported language codes](./supported-language-codes.md). | * All API operations require `Client` to be present in the request. * All API operations optionally accept `LanguageCode` and `CultureCode`. These can be used to enforce the language and culture of the operation, which affects for example the names of entities, descriptions or error messages. diff --git a/booking-engine-api/operations/availability-blocks.md b/booking-engine-api/operations/availability-blocks.md index 8362493..a274ec6 100644 --- a/booking-engine-api/operations/availability-blocks.md +++ b/booking-engine-api/operations/availability-blocks.md @@ -22,7 +22,7 @@ Availability blocks can restrict your booking engine's calendar to specific inte | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the API client, as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the API client, as described in [Authentication](../guidelines/authentication.md). | | `EnterpriseId` | string | required | Unique identifier of the hotel (enterprise). | | `AvailabilityBlockIds` | array of string | required | Set of unique identifiers of the Availability Blocks for which you want to get the details. | diff --git a/booking-engine-api/operations/configuration.md b/booking-engine-api/operations/configuration.md index caf3ff4..02ece5b 100644 --- a/booking-engine-api/operations/configuration.md +++ b/booking-engine-api/operations/configuration.md @@ -22,7 +22,7 @@ This operation can be called initially to fetch data which may be important duri | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the API client, as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the API client, as described in [Authentication](../guidelines/authentication.md). | | `PrimaryId` | string | required | Unique identifier of the primary [Configuration](#configuration-1). | | `Ids` | array of string | required | Set of unique identifiers of [Configurations](#configuration-1). | diff --git a/booking-engine-api/operations/hotels.md b/booking-engine-api/operations/hotels.md index ed03b4d..bd03a4e 100644 --- a/booking-engine-api/operations/hotels.md +++ b/booking-engine-api/operations/hotels.md @@ -17,7 +17,7 @@ Get hotels data for a single specified hotel. This operation can be called initi | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the client, as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the client, as described in [Authentication](../guidelines/authentication.md). | | `HotelId` | string | required | Unique identifier of the hotel. | ### Response @@ -415,7 +415,7 @@ The availability and pricing is returned for each applicable combination of occu | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the client as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the client as described in [Authentication](../guidelines/authentication.md). | | `ConfigurationId` | string | required | Unique identifier of the used Distributor configuration. | | `HotelId` | string | required | Unique identifier of hotel. | | `StartUtc` | string | required | Reservation start date \(arrival date\) in ISO 8601 format. | @@ -613,7 +613,7 @@ Fetch payment configuration parameters for the specified hotel. | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the client as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the client as described in [Authentication](../guidelines/authentication.md). | | `HotelId` | string | required | Unique identifier of hotel. | ### Response diff --git a/booking-engine-api/operations/reservation-groups.md b/booking-engine-api/operations/reservation-groups.md index 61c8dcd..3fe9c4e 100644 --- a/booking-engine-api/operations/reservation-groups.md +++ b/booking-engine-api/operations/reservation-groups.md @@ -54,7 +54,7 @@ Create a group of one or more reservations, i.e. make a reservation. | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Client application name, as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Client application name, as described in [Authentication](../guidelines/authentication.md). | | `ConfigurationId` | string | required | Unique identifier of the Booking Engine configuration used. | | `HotelId` | string | required | Unique identifier of the hotel. | | `Customer` | [Customer](#customer) | required | Information about the customer or guest. | @@ -216,7 +216,7 @@ Fetch details of the specified reservation group. | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Client application name, as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Client application name, as described in [Authentication](../guidelines/authentication.md). | | `HotelId` | string | required | Unique identifier of the hotel. | | `ReservationGroupId` | string | required | Unique identifier of the reservation group. | | `Extent` | [Reservation group extent](#reservation-group-extent) | optional | Extent of data to be returned. e.g. it is possible to specify that together with the reservation group, payment requests and payments will be returned. | diff --git a/booking-engine-api/operations/reservations.md b/booking-engine-api/operations/reservations.md index 24da5b2..15fb713 100644 --- a/booking-engine-api/operations/reservations.md +++ b/booking-engine-api/operations/reservations.md @@ -35,7 +35,7 @@ Get a price quotation for a specific hotel, date interval, room category and per | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the client as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the client as described in [Authentication](../guidelines/authentication.md). | | `HotelId` | string | required | Unique identifier of the hotel. | | `StartUtc` | string | required | Start date of the reservation, i.e. arrival date. | | `EndUtc` | string | required | End date of the reservation, i.e. departure date. | @@ -128,7 +128,7 @@ Get a total price for the requested reservations. | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the client as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the client as described in [Authentication](../guidelines/authentication.md). | | `ConfigurationId` | string | required | Unique identifier of the Booking Engine configuration used. | | `CurrencyCode` | string | optional | ISO 4217 code of the currency in which price will be calculated. Enterprise default currency code is used as default. [Supported currency codes](../guidelines/supported-currency-codes.md)| | `Reservations` | array of [Reservation](#reservation) | required | List of reservations. | diff --git a/booking-engine-api/operations/services.md b/booking-engine-api/operations/services.md index 5d691e5..3c3feb8 100644 --- a/booking-engine-api/operations/services.md +++ b/booking-engine-api/operations/services.md @@ -22,7 +22,7 @@ Get availability for the specified service for each time unit in the specified d | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the client as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the client as described in [Authentication](../guidelines/authentication.md). | | `EnterpriseId` | string | required | Unique identifier of the enterprise. | | `ServiceId` | string | required | Unique identifier of the [Service](configuration.md#service) for which availability should be returned. | | `StartUtc` | string | required | Start date of the requested interval. | @@ -99,7 +99,7 @@ Get pricing for the specified service for each time unit in the specified date i | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the client as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the client as described in [Authentication](../guidelines/authentication.md). | | `EnterpriseId` | string | required | Unique identifier of the enterprise. | | `ServiceId` | string | required | Unique identifier of the [Service](configuration.md#service) for which availability should be returned. | | `StartUtc` | string | required | Start date of the requested interval. | diff --git a/booking-engine-api/operations/vouchers.md b/booking-engine-api/operations/vouchers.md index 526fee9..eeffe5a 100644 --- a/booking-engine-api/operations/vouchers.md +++ b/booking-engine-api/operations/vouchers.md @@ -18,7 +18,7 @@ Determine if the specified voucher code is valid or not. | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | -| `Client` | string | required | Identification of the client as described in [Authorization](../guidelines/authorization.md). | +| `Client` | string | required | Identification of the client as described in [Authentication](../guidelines/authentication.md). | | `HotelId` | string | required | Unique identifier of hotel. | | `VoucherCode` | string | required | Voucher code enabling special rate offerings (case sensitive). | diff --git a/changelog/README.md b/changelog/README.md index 4633398..d2af786 100644 --- a/changelog/README.md +++ b/changelog/README.md @@ -1,37 +1,11 @@ # Changelog - -## 11th November 2024 -* Integrations: Updated [Google Triggers Reference](../integrations/google-triggers-reference.md), updated purchase event location and trigger condition. - -## 28th August 2024 -* API: Fixed documentation for `Customer` which never accepted address fields and is of the same type as `Booker` in [Create reservation group](../booking-engine-api/operations/reservation-groups.md#create-reservation-group). Documentation only. - -## 22nd July 2024 -* Integrations: Added new page [Google Analytics cross-domain tracking](../integrations/ga-cross-domain-tracking.md). - -## 6th June 2024 -* Integration: Added [Disclaimer regarding Google Analytics data accuracy](../integrations/google-tag-manager.md) - -## 7th May 2024 -* Widget: Changed GA4 `purchase` event in the [Google Triggers Reference](../integrations/google-triggers-reference.md#purchase) so it now lists products and rooms as separate items. - -## 19th April 2024 -* Widget: Updated Content Security Policy details for Booking Engine Widget in [Getting Started](../booking-engine-widget/getting-started.md#content-security-policy). - -## 28th March 2024 -* Widget: Added [Illustration of GA4 Events in the Booking Engine](../integrations/google-triggers-reference.md#illustration-of-ga4-events-in-the-booking-engine). - -## 18th March 2024 -* API: `AdultCount` and `ChildCount` deprecated and replaced by `OccupancyData` in [Get availability](../booking-engine-api/operations/hotels.md#get-availability), [Get reservations pricing](../booking-engine-api/operations/reservations.md#get-reservations-pricing) and [Get reservation price](../booking-engine-api/operations/reservations.md#get-reservation-price). -* General: Added [Where can I get Age Category ID?](../FAQ/README.md#where-can-i-get-age-category-id). -* Widget: Added detailed guide on [Disabling widget caching](../booking-engine-widget/use-cases/disable-widget-caching.md). - -## 5th March 2024 -* Widget: Updated Content Security Policy requirements for Booking Engine Widget in [Getting Started](../booking-engine-widget/getting-started.md#content-security-policy). +## 4th February 2025 +* API: Renamed and rewritten [Authentication](../booking-engine-api/guidelines/authentication.md) page, and other small changes. Documentation-only, no change to the API. | Changelog by year | | :-- | +| [Changelog 2024](changelog2024.md) | | [Changelog 2023](changelog2023.md) | | [Changelog 2022](changelog2022.md) | | [Changelog 2021](changelog2021.md) | diff --git a/changelog/changelog2020.md b/changelog/changelog2020.md index 5932a62..722e005 100644 --- a/changelog/changelog2020.md +++ b/changelog/changelog2020.md @@ -2,7 +2,7 @@ ## 26th November 2020 -* API: Changed of [API Client Authorization](../booking-engine-api/guidelines/authorization.md). Where the client needs to be registered. +* API: Updated [Authentication](../booking-engine-api/guidelines/authentication.md) page. ## 20th November 2020 diff --git a/changelog/changelog2024.md b/changelog/changelog2024.md new file mode 100644 index 0000000..91583ab --- /dev/null +++ b/changelog/changelog2024.md @@ -0,0 +1,34 @@ +# Changelog 2024 + +## 11th November 2024 +* Integrations: Updated [Google Triggers Reference](../integrations/google-triggers-reference.md), updated purchase event location and trigger condition. + +## 28th August 2024 +* API: Fixed documentation for `Customer` which never accepted address fields and is of the same type as `Booker` in [Create reservation group](../booking-engine-api/operations/reservation-groups.md#create-reservation-group). Documentation only. + +## 22nd July 2024 +* Integrations: Added new page [Google Analytics cross-domain tracking](../integrations/ga-cross-domain-tracking.md). + +## 6th June 2024 +* Integration: Added [Disclaimer regarding Google Analytics data accuracy](../integrations/google-tag-manager.md) + +## 7th May 2024 +* Widget: Changed GA4 `purchase` event in the [Google Triggers Reference](../integrations/google-triggers-reference.md#purchase) so it now lists products and rooms as separate items. + +## 19th April 2024 +* Widget: Updated Content Security Policy details for Booking Engine Widget in [Getting Started](../booking-engine-widget/getting-started.md#content-security-policy). + +## 28th March 2024 +* Widget: Added [Illustration of GA4 Events in the Booking Engine](../integrations/google-triggers-reference.md#illustration-of-ga4-events-in-the-booking-engine). + +## 18th March 2024 +* API: `AdultCount` and `ChildCount` deprecated and replaced by `OccupancyData` in [Get availability](../booking-engine-api/operations/hotels.md#get-availability), [Get reservations pricing](../booking-engine-api/operations/reservations.md#get-reservations-pricing) and [Get reservation price](../booking-engine-api/operations/reservations.md#get-reservation-price). +* General: Added [Where can I get Age Category ID?](../FAQ/README.md#where-can-i-get-age-category-id). +* Widget: Added detailed guide on [Disabling widget caching](../booking-engine-widget/use-cases/disable-widget-caching.md). + +## 5th March 2024 +* Widget: Updated Content Security Policy requirements for Booking Engine Widget in [Getting Started](../booking-engine-widget/getting-started.md#content-security-policy). + +| Next | +| :-- | +| [Changelog 2023](changelog2023.md) | diff --git a/integrations/gtm-skeleton.md b/integrations/gtm-skeleton.md index 05f76d3..38774f0 100644 --- a/integrations/gtm-skeleton.md +++ b/integrations/gtm-skeleton.md @@ -1,44 +1,44 @@ -# Google Tag Manager Skeleton Configuration +# Google Tag Manager Configuration This guide provides a streamlined process for exporting and configuring a Google Tag Manager (GTM) skeleton suitable for booking engine. Follow these precise steps to efficiently adapt your GTM setup to new requirements. -## Prepare Your Configuration +## Prepare Your configuration -1. **Download the Configuration File:** +1. **Download the configuration file:** - Access the prepared skeleton configuration file: [Google Tag Manager - Configuration.json](../.gitbook/assets/GTM-Mews.json). -2. **IMPORTANT: Customize the Configuration:** +2. **IMPORTANT: Customize the configuration:** - Open the downloaded JSON file in your preferred text editor. - Replace all occurrences of `_GA4_ID_` with your actual Google Analytics 4 (GA4) tracking ID. -3. **Prepare for Import:** +3. **Prepare for import:** - Save the changes to the JSON file, ensuring it is ready to be imported into your GTM account. -## Import Configuration into Google Tag Manager +## Import configuration into Google Tag Manager -### Import the Modified File: +### Import the modified file: -- **Navigate to Import Options:** +- **Navigate to import options:** - In your GTM account, go to the **Admin** tab. - Under the container options, select **Import Container**. -- **Select and Upload File:** +- **Select and upload file:** - Click on **Choose file** and select your modified JSON file. - Decide how to merge this configuration with any existing setup. Options include: - **Overwrite**: Replaces the current container with the imported one. - **Merge**: Combines the imported configuration with the existing one, with options to resolve conflicts. - **Rename**: Adds the imported configuration while renaming any conflicts. -- **Complete the Import:** +- **Complete the import:** - Follow prompts to finalize the import process. -### Update and Publish: +### Update and publish: -- **Review Configuration:** +- **Review configuration:** - Thoroughly check all tags, triggers, and variables to ensure they are correctly configured. -- **Test Before Publishing:** +- **Test before publishing:** - Utilize GTM's preview mode to test the setup. Ensure that all configurations perform as expected. -- **Publish Changes:** +- **Publish changes:** - Once verified, publish the container to apply your configurations live.