webmaster api - vertical booking€¦ · 2 internet booking engine 2.1 hotel the vertical booking...

• VERTICAL BOOKING USA - 122115 NW Imbrie Street, NBR 326, Hillsboro OR 97124 (USA) I [email protected] • VERTICAL BOOKING FRANCE - 18, rue Pasquier 75008 Paris, France I [email protected] • VERTICAL BOOKING ITALY I sales @verticalbooking.com

A.E.C. Advertising and Electronic Commerce srl - Piazza Pontida, 7, 24122 Bergamo (Italy) Corporation Stock: 100.000 EUR fully paid-up | CF and P.Iva IT02657150161 | REA Bergamo: 312569 Single shareholder. Company subject to management and coordination by GUADAFIN s.r.l

Webmaster API

Vertical Booking Integration API for Webmaster

24-March 2016- ver. 3.0

Webmaster API 2 | 24 24-March 2016 ver. 3.0



Index

1 Introduction ......................................................................................................... 3

2 Internet Booking Engine ...................................................................................... 4 2.1 HOTEL ............................................................................................................. 4

2.1.1 SMART ....................................................................................................................................... 4 2.1.2 ADVANCED ................................................................................................................................. 7 2.1.3 VILLAS ...................................................................................................................................... 11

3 Reservation front end URL.................................................................................. 14 3.1 Standard front end URL.................................................................................... 14 3.2 Custom third-level front end URL ...................................................................... 14 3.3 Custom front end URL ...................................................................................... 14

4 Special offers ..................................................................................................... 15 4.1 HTML + CSS Version – ASP inclusion ................................................................. 15 4.2 HTML + CSS Version – PHP inclusion ................................................................. 15 4.3 PHP serialized array version – PHP inclusion ....................................................... 15

5 Request for proposal .......................................................................................... 16 5.1 Needed fields for result form ............................................................................ 16 5.2 Result form .................................................................................................... 17

6 Request for recall ............................................................................................... 18 6.1 Needed fields for Result form ............................................................................ 18 6.2 Result form .................................................................................................... 18

7 Corporate customer registration ........................................................................ 19 7.1 Needed fields for Result form ............................................................................ 19 7.2 Result form .................................................................................................... 19

8 Google analytics ................................................................................................. 20 8.1 Inserting the Google Analytics script in the hotel website ..................................... 20 8.2 Inserting the Code into the Vertical Booking Extranet .......................................... 20 8.3 Inserting an Analytics-enabled quick reserve ...................................................... 21 8.4 Inserting an Analytics-enabled link .................................................................... 21 8.5 Set Referral Exclusion ...................................................................................... 21 8.6 Goals and funnels ............................................................................................ 22

8.6.1 SMART ..................................................................................................................................... 23 8.6.2 ADVANCED ............................................................................................................................... 23 8.6.3 VILLAS ...................................................................................................................................... 23

8.7 Custom page names ........................................................................................ 23




1 Introduction

Vertical Booking is a complete and versatile CRS, including an online booking system.




2 Internet Booking Engine

2.1 HOTEL

The Vertical Booking Engine is available in 4 versions, all responsive:

• SMART For Business hotels. Simple, fast with complete information

• ADVANCED For Leisure hotels. Highlights pakages and offers

• PREMIUM The most advanced interface, it can adapt to any kind of property

• VILLAS For Residence, Villas, Service Apartments and Hotels. Highlights rooms or apartments

2.1.1 SMART




2.1.1.1 Direct link

URL : https://reservations.verticalbooking.com/reservation_hotel_start.htm

URL Parameters :

Parameter URL name Type Description id_albergo Numeric Property identification number, provided by Vertical Booking dc Numeric Security code, provided by Vertical Booking lingua_int ita, eng, usa,

deu, fra, esp, rus, dut, por, fin, ell, chi, kor, jpn, tha, vie, bul, nor, sve, ron, pls, etn, hun, slo, cze, dan, cat, bra

Language code used on the web frontend

id_stile Numeric Style code that identify the CSS used on the booking frontend, provided by Vertical Booking

Example :

https://reservations.verticalbooking.com/reservation_hotel_start.htm?id_stile=8749&lingua_int=eng&id_albergo=31&dc=466

https://reservations.verticalbooking.com/reservation_hotel_start.htm

2.1.1.2 Quick Reserve

At the address below it is possible to download a ZIP file containing two examples of quick reserve modules that are ready to use, that can be customized via CSS.

http://www.verticalbooking.com/quickreserve/quick_reserve.zip

The HTML in each of the two files (quick_reserve.html or quick_reserve_two_calendars.html) is ready to be embedded in any web site and customized with CSS.

As you can see from the script below, there are placeholders which need to be substituted. The values to use are the ones provided in section 2.1.1.1.

<div> <form action="https://reservations.verticalbooking.com/reservation_hotel.htm"

method="post" name="myform" id="myform" target="_blank" onsubmit="invia_form();">

... <input name="gg" id="gg" value="" type="hidden"> <input name="mm" id="mm" value="" type="hidden"> <input name="aa" id="aa" value="" type="hidden"> <input name="id_albergo" value="<!— See id_albergo on section 2.1.1.1 -->" type="hidden"> <input name="lingua_int" value="<!— See lingua_int on section 2.1.1.1 -->" type="hidden"> <input name="dc" value="" type="hidden"> <input name="id_stile" value="" type="hidden"> ... </div>




2.1.2 ADVANCED

Results page

Package and offers page




2.1.2.1 Direct link

URL : https://reservations.verticalbooking.com/reservations/index.html

URL Parameters :

Name Type Description id_albergo Numeric Property identification number, provided by Vertical Booking dc Numeric Security code, provided by Vertical Booking lingua_int ita, eng, usa,

deu, fra, esp, rus, dut, por, fin, ell, chi, kor, jpn, tha,





vie, bul, nor, sve, ron, pls, etn, hun, slo, cze, dan, cat, bra


Example :

https://reservations.verticalbooking.com/reservations/index.html?id_stile=10271&lingua_int=eng&id_albergo=78&dc=189









<div> <form action="https://reservations.verticalbooking.com/reservations/risultato.html"







2.1.3 VILLAS

First Page

Results page




2.1.3.1 Direct link

URL : https://reservations.verticalbooking.com/common/villas/index.html

URL Parameters :

Name Type Description id_albergo Numeric Property identification number, provided by Vertical Booking dc Numeric Security code, provided by Vertical Booking lingua_int ita, eng, usa, deu,

fra, esp, rus, dut, por, fin, ell, chi, kor, jpn, tha, vie, bul, nor, sve, ron, pls, etn, hun, slo, cze, dan, cat, bra



Example :

https://reservations.verticalbooking.com/common/villas/index.html?id_stile=9307&lingua_int=eng&id_albergo=9584&dc=401









<div> <form action="https://reservations.verticalbooking.com/common/villas/rooms.html"







3 Reservation front end URL

3.1 Standard front end URL

The standard frontend URL uses the domain

https://reservations.verticalbooking.com

3.2 Custom third-level front end URL

It is possible to use a third level domain of verticalbooking.com hinting the name of the hotel, the name of the chain or the web portal name on which the end user will perform the reservation. In fact it is possible to configure a generic third level domain like, for example:

https://myhotelname.verticalbooking.com

https://myhotelchain.verticalbooking.com

https://myportalname.verticalbooking.com

All these hotels share the same SSL technology to provide information encryption and have the same degree of security of the default URL.

3.3 Custom front end URL

Lastly, it is even possible to use a completely customized URL, for example:

https://secure.myhotelname.com

This solution has a higher cost in resources because Vertical Booking needs to reserve an IP address for this purpose only, and we have a limited number of these IP addresses shared with all the system.

https://reservations.verticalbooking.com/

https://myhotelname.verticalbooking.com/

https://secure.myhotelname.com/

4 Special offers

4.1 HTML + CSS Version – ASP inclusion

It is possible to include a widget in the website both directly and server-side in order to include the list of the special offers in a page.

<% url = " https://reservations.verticalbooking.com/xml/offerte_css_analytics2.htm?id_albergo=<!—HOTEL ID VALUE -->&dc=0&lingua_int=&id_stile=<!—STYLE CODE -->&user=albergo_<!—HOTEL ID VALUE -->&pass=" set xmlhttp = CreateObject("MSXML2.ServerXMLHTTP") xmlhttp.open "GET", url, false xmlhttp.send "" Response.write xmlhttp.responseText set xmlhttp = nothing %>

4.2 HTML + CSS Version – PHP inclusion

It is possible to include a widget in the website both directly and server-side in order to include the list of the special offers in a page.

<?php include(' https://reservations.verticalbooking.com/xml/offerte_css_2.htm?id_albergo=<!—HOTEL ID VALUE -->&dc=&lingua_int=&id_stile=<!—STYLE CODE -->&user=albergo_<!—HOTEL ID VALUE -->&pass=’); ?>

4.3 PHP serialized array version – PHP inclusion

It is possible to obtain in a single PHP array variable all the information concerning the special offers. An example could be the following request:

<?php $stringa_array = file_get_contents('https://xml.verticalbooking.com/htng/prices/Offers.htm?id_albergo=&lingua_int=&user=albergo_'); echo $stringa_array; $array_ritornato = unserialize($stringa_array); print_r($array_ritornato); ?>




5 Request for proposal

5.1 Needed fields for result form

If the hotel would like to insert a custom form in the website, just insert the following HTML fields and post them to the indicated page (result form):

Field name Mandatory Meaning nome yes First name of the applicant cognome yes Last name of the applicant telefono yes Number of telephone of the

applicant email yes Email of the applicant (must be a

valid email address) lingua_int yes Customer or site language (three

chars, ‘eng’ for example) id_albergo yes ID of the hotel at which the

customer wants to request a quote

gg yes Day of arrival [1-31] mm yes Month of arrival [1-12] aa yes Year of arrival [current_year,

current_year+5] notti yes Number of nights of stay [1-120] tot_adulti yes Number of adults tot_bambini no Number of children tot_camere yes Number of rooms etabambn yes (if tot_bambini > 0) Each children age (for example

etabamb1 = 4; etabamb2 = 5 ie first children 4 years old, second children 5 years old)

prezzo_proposto no Any proposed price per night and per person (the currency will be that used by the hotel)

final_page no URL of the final page, in case of successfully request

note no Any customer note origin no Request source (could be used in

order to identify requests coming from chain page or property page)

NOTE: The price offered will only be accepted by the hotel in the stated period.




5.2 Result form

The form must have the following string as ACTION attribute:

https://reservations.verticalbooking.com/quot_web_req/invia_richiesta_preventivo_ris.htm

https://reservations.verticalbooking.com/quot_web_req/invia_richiesta_preventivo_ris.htm




6 Request for recall

There are two ways to insert a recall request (7.1 and 7.2).

6.1 Needed fields for Result form

If the hotel would like to insert a custom form in the website, just insert the following HTML fields and post them to the indicated page (result form):

Field name Mandatory Meaning nome Yes First name of the applicant cognome Yes Last name of the applicant telefono Yes Telephone number of the

applicant email Yes

Email of the applicant (must be a valid email address)

id_albergo Yes* ID of the hotel at which the customer wants to request a quote

id_gruppo Yes* ID of the hotel group at which the customer wants to request a quote

telefono Yes Telephone number of the applicant

cellulare No Mobile number of the applicant note No Any customer note

NOTE: The recall request will only be accepted by the hotel in the stated period.

6.2 Result form

The form must have the following string as ACTION attribute:

https://reservations.verticalbooking.com/recall_service/invia_richiesta_recall_ris.htm

https://reservations.verticalbooking.com/recall_service/invia_richiesta_recall_ris.htm




7 Corporate customer registration

Vertical Booking offers a way to automatically insert a customer into the hotel CRS customers section. The page below is to be inserted in an iframe:

7.1 Needed fields for Result form

Field name Mandatory Meaning id_gruppo No Chain identifier tipo Yes Customer type. Must be

“Azienda” lingua_int Yes Language of the reservation ita,

eng, deu, fra, esp, rus, dut, tur, por, fin, ell, chi, kor, jpn, tha, vie, bul, nor, sve, ron, pls, etn, hun, slo, cze, dan

rag_sociale Yes

Company name

indirizzo Yes Company address

cap Yes Company zip code

localita Yes Company city name provincia No Company province nazione Yes Country telefono No Phone number fax No Fax number cellular No Reference mobile email No Reference email cod_fiscale No Personal Tax ID partita_iva Yes Company Tax ID ref_ruolo No Referent position ref_cognome Yes Referent surname ref_nome Yes Referent first name ref_telefono No Referent phone ref_cellulare No Referent mobile ref_email Yes Referent email ref_note No Referent note

7.2 Result form

https://reservations.verticalbooking.com/cli_registra_ris.htm

https://reservations.verticalbooking.com/cli_registra_ris.htm?id_albergo=%3c!--%20HOTEL%20ID--%3e&lingua_int=%3c!%E2%80%94LANGUAGE%20--%3e




8 Google analytics

In order to activate the interface between Vertical Booking and Google analytics we need:

• An account in Google Analytics set for Universal Analytics • Google Analytics UA-XXXXXXX-X code • A hotel using the Vertical Booking Booking Engine willing to track its reservations with Google

Analytics.

8.1 Inserting the Google Analytics script in the hotel website

The first thing a hotel must do in order to enable Analytics tracking, is to insert the Analytics script code in all the web pages. There are three types of Google Analytics scripts, and both Google and Vertical Booking suggest using the “Universal Analytics” script. This should be inserted after the beginning <body> tag and should look like the following extract:

<script type="text/javascript">

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-XXXXXXX-XX', 'auto', {'allowLinker': true}); ga('require', 'linker'); ga('linker:autoLink', [/\.(com|net)$/], true, true); ga('require', 'displayfeatures'); ga('require', 'linkid', 'linkid.js'); ga('send', 'pageview'); </script>

8.2 Inserting the Code into the Vertical Booking Extranet

Be sure that the same UA-XXXXXXX-X code is inserted into the Vertical Booking Conversion analysis – Google page.

Enable the Universal Analytics feature




8.3 Inserting an Analytics-enabled quick reserve

In Vertical Booking, a ‘quick reserve’ is a portion of a webpage in the hotel website that contains a form providing reservation information to the booking engine. The ‘quick reserve’ must comply with the following rules:

• It must have a <form …> tag • The action must be one of the following, depending on the version of the graphic interface

o Interface by room: prenota_new.htm o Interface by rate: prenota_new.htm o One page Interface : prenota_grafica_b.htm

• The method must be POST • There must not be scripts which trigger the submit action.

This is an example of how the form could look:

<form action="https://reservations.verticalbooking.com/prenota_new.htm" method="post" name="myform" id="myform" target="_parent"> <input name="tappa_1_id_albergo" value="2887" type="hidden"> ...... <input type="submit" name="invia" value="Book Now!" /> </form>

8.4 Inserting an Analytics-enabled link

The hotel website could choose not to display a quick reserve module, and instead just display a link redirecting the user to the booking engine. In this case, we also have to pass the Analytics information in order for the tracking to work correctly.

Below is an example of an analytics-enabled link:

<a href=https://reservations.verticalbooking.com/prenota_new.htm?id_albergo=2887>Book Now</a>

8.5 Set Referral Exclusion

In order to make sure that traffic from your .com domain to the verticalbooking domain won’t trigger a new session, you have to add your domain to the “Referral Exclusion List” on your GA account.

To do this, go back to the GA account and go to the Admin section. Select your property and select Referral Exclusion List:

https://reservations.verticalbooking.com/prenota_new.htm?id_albergo=2887




Click +ADD REFERRAL EXCLUSION

Enter your .com site domain and and “secure.alesiadistribution.com” domain for exclusion

Now if you login to GA, you will see the transaction source of the booking engine page is no longer misinterpreted as referral from your .com site, but instead shows the actual source that directed the visitor to the site originally (e.g. social, search etc.). You can use this information to identify which acquisition channels you should be focusing on.

8.6 Goals and funnels

http://www.whymeasurethat.com/wp-content/uploads/2013/05/GA-referral-exclusion-list.png




Although it is not mandatory, defining goals and funnels is one of the most interesting features provided by Google Analytics. We decided to include a list of the page names in this document, which are named to let you easily define funnels. In addition, in section 4.4, you will see how to define custom page names.

8.6.1 SMART

• reservation_hotel_start.htm • reservation_hotel.htm • reservation_services.htm • reservation_summary.htm • reservation_offer.htm • reservation_thanks.htm

8.6.2 ADVANCED

• index.html • risultato.html • servizi.html • dati.html • index_pacchetti.htm • tanks_page.htm

8.6.3 VILLAS

• index.html • rooms.html • room_details.html • summary.html • tanks_page.htm

8.7 Custom page names

The interface with Google Analytics lets you define custom page names. In the Conversion analysis – Google section, all you have to do is activate the feature and indicate the custom page names you want to use.




Note that these names will be used independently by the version of the booking engine the customer will be using (per room, per camera, emotional or mobile). This lets you implement a multi-channel tracking strategy, defining goals and funnels only once.

webmaster api - vertical booking€¦ · 2 internet booking engine 2.1 hotel the vertical booking...

Documents