Skip to content

Latest commit

 

History

History
111 lines (80 loc) · 4.02 KB

advanced-guide.md

File metadata and controls

111 lines (80 loc) · 4.02 KB
Raw

Advanced Guide

Full example

Note:

Direct configuration of Distributor through the options has been deprecated and it will be disabled in future. Prefer to use Distributor Configuration in Commander. The only supported now areconfigurationIdsandopenElements.

Example with all possible options and their default values follows. To get further information about the options and an API call, see the reference.

Important: This is just an example, do not copy this directly to your website!

<script>
Mews.Distributor({
    // required
    configurationIds: [
        'aaaa-bbbb-cccc-dddd-eeeeeeee'
    ],
    // optionals
    openElements: '',
},
function(distributor) {
    // Always available api calls
    // distributor.open();
    // distributor.setLanguageCode(languageCode);
    // distributor.setCurrencyCode(currencyCode);
    // distributor.setStartDate(date);
    // distributor.setEndDate(date);
    // distributor.setVoucherCode(code);
    // distributor.setRooms(rooms);
    // Singlehotel mode api calls
    // distributor.showRooms();
    // distributor.showRates(roomId);
    // Multihotel mode api calls
    // distributor.showHotels();
    // distributor.showRooms(hotelId);
    // distributor.setCity(cityId);
});
</script>

Note

See that you have just one<script>tag containingMews.Distributorcall on your page.

Deeplinks

Distributor recognises a set of parameteres passed to it in a URL query. This allows you to deeplink into booking engine from other websites. Important: This should not be used as a standard way to open Distributor from your own website

Recognised parameters are:

Name Description
mewsDistributorOpened tells the Distributor to open automatically
mewsStart an arrival date in ISO 8601 format (YYYY-MM-DD)
mewsEnd a departure date in ISO 8601 format (YYYY-MM-DD)
mewsVoucherCode a voucher code
mewsRoute opens on specified step (one of rooms, rates)
mewsRoom opens with specified room selected (aaaa-bbbb-cccc-dddd)
language a language code (xx-YY)
currency a currency code (XXX)

In addition, Distributor in multihotel mode also supports:

Name Description
mewsCityId opens with specified city selected (aaaa-bbbb-cccc-dddd)
mewsHotel opens with specified hotel selected (aaaa-bbbb-cccc-dddd)
mewsRoute in addition to rooms and rates, supports also hotels step

Examples

  • presets a start date, voucher code and language, but Distributor stays closed

    http://www.yourwebsite.com/?mewsStart=2015-01-01&mewsVoucherCode=special-discount&language=en-US

  • opens Distributor with preselected room and currency on rate selection step

    http://www.yourwebsite.com/?mewsDistributorOpened&currency=EUR&mewsRoute=rates&mewsRoom=aaaa-bbbb-cccc-dddd

  • opens multihotel Distributor with preselected city hotel selection step

    http://www.yourwebsite.com/?mewsDistributorOpened&mewsRoute=hotels&mewsCityId=aaaa-bbbb-cccc-dddd

Note

The deeplinks are also supported by standalone Distributor.

Payment card storages

Payment card storage is used to safely collect and store information about a customer's payment card. Currently Distributor supports these payment card storages:

Payment gateways

Payment gateway is used to securely handle customer payments. A configuration is done once, when the property is set up. Official Mews Distributor client can use it with minimal setup. Currently Distributor supports these payment gateways:

Using payment gateway is not mandatory, as reservations can be created without providing a payment card information.

Important: PCI Security Standard requires you to use SSL Certificate on your website to be allowed to collect any payments info.