Sie sind auf Seite 1von 34

Liligo widget API v2.

Change log :
Added in version 2.6
- Best Offers widget​ has been modified
- Flight xml feed url​ has been modified
[February 22, 2018]

Added in version 2.5


- Color codes for Car Rental Category
Added in version 2.4
- Direct flight prefiltering support (options sections on page 11)
Added in version 2.3
- Best Offers widget
- Flight xml feed url has been modified

1
Contents

Introduction
Overview of the integration
Integration through widgets
Integration with hosted result page
Search form widget
Layout
Configuration
Result page widget
Layout
Code Sample
Configuration
Inspiration form flight widget
Sample layout
Configuration
Inspiration result page widget
Code sample
Sample layout
Parameters
Options
Flight direct link
URL
Parameters
Code sample
Sample layout
Parameters
Best Offer Widget
Code sample
Sample layout
Parameters
URL
Flight destination selection service
URL
Parameters
Sample call
Output format
Flight cache service
URL
Output format

© 2010 - 2018 Copyright Liligo Metasearch Technologies 2 of 34


Parameters
Flight XML feed
Parameters
Example
Hotel XML feed
Parameters
Example
Package XML feed
Parameters
Example
Sample codes
Multiple integration code

Appendix
Customizable color codes
Flight search form
Flight result page
Flight detail view
Flight redirect view
Car search form
Car result page
Car redirect page

© 2010 - 2018 Copyright Liligo Metasearch Technologies 3 of 34


Introduction

Liligo widgets are packaged in widget script to make their integration easier.
Each widget has some parameters to customize the integration.
Liligo widgets are responsive, their size will be adjusted according to the space allocated to
their container ( min width is 300 px ).

Overview of the integration

Integration through widgets

By specifying a resultPageRedirect URL when you launch a search, you can redirect the
user to a page on your domain and includes the result page widget in your page.

Integration with hosted result page


In this integration, the Liligo result page will appear in full screen. This is the behaviour,
when resultPageRedirect is not specified in the widget.

© 2010 - 2018 Copyright Liligo Metasearch Technologies 4 of 34


Search form widget

By integrating this script in your page, you will display a liligo search form at the location of
the script.
Product defines the default category displayed
Preset allow to define the departure and destination default value.
Result url is the url to your website where the result page widget is integrated.

Layout

© 2010 - 2018 Copyright Liligo Metasearch Technologies 5 of 34


Code sample
<script>
window.liligoWidgets = window.liligoWidgets || [];
liligoWidgets.push(["init", {
widget: "searchForm",
targetDivId: "divId",
​options: {
​product: "flight",
​flight: {
resultPageRedirect: "​http://url-to-flight-result-page​",
from: "Paris",
​ ​to: "London"
}
}
}]);
</script>
<script src="​http​://​{white_label_domain}​/servlet/api/widgets/v2.js​"​> </script>

{white_label_domain} refers to the whitelabel subdomain hosted on Liligo platform which


operates the flight searches.

Configuration

Parameter Value Description

targetDivId Id of the html div to Define the location of the


integrate the form search form in the html
page

widget searchForm Specify that the widget


displays a search form

Options JSON object Define configuration


element of the search form

Options:
product defines the category to display among : “flight”, “car”, “hotel”,”package”
flight is a json object which defines the specific options for the flight search form
·​ ​resultPageRedirect : ​defines the url of the result page ( specified for each category ).

·​ ​from/to : ​preset defines the default city name , country name or iata code to display in ​from

and /or ​to​ fields. For country name, the most popular airport/city will be displayed.

© 2010 - 2018 Copyright Liligo Metasearch Technologies 6 of 34


Result page widget

Layout

Code Sample
​<script>
window.liligoWidgets = window.liligoWidgets || [];
liligoWidgets.push(["init", {
widget: "resultPage",
targetDivId: "divId",
options: {
product: "flight"
}
}]);
</script>
<script src="http://{white_label_domain}/servlet/api/widgets/v2.js"> </script>

{white_label_domain} refers to the whitelabel subdomain hosted on Liligo platform which


operates the flight searches. 

© 2010 - 2018 Copyright Liligo Metasearch Technologies 7 of 34


Configuration
Parameter Value Description

targetDivId Id of the html div to Define the location of the


integrate the form search form in the html
page

widget searchForm Specify that the widget


displays a search form

Options JSON object Define configuration


element of the search form

Inspiration form flight widget

Code Sample

<script src="http://{​white_label_domain​}/servlet/api/widgets/v2.js"></script>
<div id="targetDiv"></div>
<script>
window.liligoWidgets = window.liligoWidgets || [];
liligoWidgets.push(['init', {
widget: "inspirationForm",
targetDivId: "targetDiv",
options: {
flight: {
resultPageRedirect: "{inspiration result page url}",
directOnlyPrefiltering: "true"
}
}
}]);
</script>

© 2010 - 2018 Copyright Liligo Metasearch Technologies 8 of 34


Sample layout

Configuration
Parameter Value Description

targetDivId Id of the html div to Define the location of the


integrate the form search form in the html
page

widget inspirationForm Specify that the widget


displays a search form

Options JSON object Define configuration


element of the search form

© 2010 - 2018 Copyright Liligo Metasearch Technologies 9 of 34


Inspiration result page widget

Code sample
<script src="http://{​white_label_domain​}/servlet/api/widgets/v2.js"></script>
<div id="targetDiv"></div>
<script>
window.liligoWidgets = window.liligoWidgets || [];
liligoWidgets.push(['init', {
widget: "destinationFeed",
targetDivId: "targetDiv",
integrateBy: "url",
options: {
flight: {
resultPageRedirect: "{flight_resultpage_url}",
directOnlyPrefiltering: true
}
}
}]);
</script>

Sample layout

© 2010 - 2018 Copyright Liligo Metasearch Technologies 10 of 34


Parameters
Parameter Value Description

targetDivId Id of the html div to Define the location of the


integrate the form search form in the html
page

integrateBy url Fix

widget destinationFeed Name of the widget to use

Options JSON object Define configuration


element of the search form

Options
For each product among : “flight”, “car”, “hotel”

resultPageRedirect defines the url of the result page ( used for


link building from the offers ) can be used
on flight, hotel, car categories

directOnlyPreFiltering pre-set the direct only filtering on the flight


result page, the non-direct result items are
hidden(filtered out) by default, can be used
on flight result page

Flight direct link


This service allows to launch a search to redirect to your flight result page which integrates
the liligo widget.

URL
http://{white_label_domain}/mobileweb_v4/api/launch.jsp

Sample call
http://{white_label_domain}/mobileweb_v4/api/launch.jsp?apiVersion=2&class=EC&dep=2017-12-15&fromI
ATA=BCN&passengers=1,0,0&product=air&ret=2017-12-22&roundTrip=roundTrip&toIATA=MRS&direct=1
&redirectUrl={parner_domain_resultpage}

© 2010 - 2018 Copyright Liligo Metasearch Technologies 11 of 34


Parameters
Parameter Value Description

dep YYYY-MM-DD Departure date

ret YYYY-MM-DD Return date

fromIATA Cityname or IATA code Departure location

toIATA Cityname or IATA code Arrival location

passengers 1,0,0 Number of adults, children,


infants separated with
comma

roundTrip roundtrip Roundtrip or oneway search


( in this last case, return
date is not needed )

exclude -exact true/false Exclude exact departure /


arrival date

class EC Cabin class for search EC


for economy, PE for
premium economy, FC for
FirstClass and BC for
business Class

product air Specify it is a flight search

apiVersion 2 Mandatory to redirect to the


proper result page

redirectUrl http://www.partner.com/fligh The complete url of the


_result _page page which embeds the
liligo result page widget.
Service will perform the
search and redirect to the
redirect url specified in this
parameter

direct 1 Pre-set the direct only


filtering on the flight result
page, the non-direct result
items are hidden(filtered
out) by default

© 2010 - 2018 Copyright Liligo Metasearch Technologies 12 of 34


Best Offer widget

Code sample
<script src="http://{​white_label_domain​}/servlet/api/widgets/v2.js"></script>
<div id="targetDiv"></div>
<script>
window.liligoWidgets = window.liligoWidgets || [];
liligoWidgets.push(['init', {
widget: "bestOffer",
targetDivId: "targetDiv",
integrateBy: "url",
options: {
box: "3",
departure: "paris_FR",
arrival: "world",
resultPageRedirect: "{{result_page}}"
}
}]);
</script>

Sample layout

© 2010 - 2018 Copyright Liligo Metasearch Technologies 13 of 34


Parameters

box Specify the box type 3 or 1 is accepted.


- “3” the large one, can handle three rows.
Size; Width: 300px or wider, Height: 295px
- “1” small one, up to five rows.
Size; Width 240 or wider, Height: 320px

departure Departure parameter in the request.


Use with:
- world/monde/mundo for world wide
- cityname_COUNTRYCODE for specific
country
- EUR for europe
- two letters country code for country

arrival Arrival parameter in the request.


Use with:
- world/monde/mundo for world wide
- cityname_COUNTRYCODE for specific
country
- EUR for europe
- two letters country code for country

resultPageRedirect The complete url of the page which embeds


the liligo result page widget. Service will
perform the search and redirect to the
redirect url specified in this parameter

© 2010 - 2018 Copyright Liligo Metasearch Technologies 14 of 34


Flight destination selection service
This service allows to search for a IATA code in our repository

URL
http://{white_label_domain}/servlet/comp

Parameters
Parameter Value Description

type flight Don’t change this parameter

apiVersion 1 Don’t change this parameter

frag Cityname or IATA code to Value you are searching for


search

maxrows integer Nb of results to return

Sample call
http://{white_label_domain}/servlet/comp?type=flight&apiVersion=1&frag=Madrid&maxrows=15

Output format
[{"country":"France","city":"Marseille","highlighted":"<strong>Marseille<\/strong>, France - tous
aéroports (MRS)","IATA":"MRS","label":"Marseille, France - tous aéroports
(MRS)","type":"1","relevance":1,"airport":"tous
aéroports","showStateInfo":false,"countryCode":"FR","accessibleByPlane":true,"state":null,"value":"1,3
0001096,0","group":1},{...}]

Service returns an array of json objects.

Flight cache service


This service returns recent offers from recent searches for a given route and a range of
dates.

URL
http://{white_label_domain}/servlet/flight-cache

Sample call
http://{white_label_domain}/servlet/flight-cache?depdate=2016-11-30&retdate=2016-12-05&from=MRS&to=
PAR&direct=true&range=1&exclude-exact=false

© 2010 - 2018 Copyright Liligo Metasearch Technologies 15 of 34


Output format
Each Item has the following format in JSON :

"roundTrip": true,
"providerCode": "GTG",
"arrCityName": "Paris",
"inbound": {
"supplierName": "Air France",
"duration": 85,
"date": "2017-02-05",
"flightCode": "AF7660",
"arrDate": 1486281000000,
"arrStation": "MRS",
"supplier": "AF",
"stops": 0,
"depStation": "CDG",
"depDate": 1486275900000
}

Parameters

Parameter Value Description

depdate YYYY-MM-DD Departure date

retdate YYYY-MM-DD Return date

from Cityname or IATA code Departure location

to Cityname or IATA code Arrival location

direct true/false Only direct flights

range n Number of days around the


departure and return dates

exclude -exact true/false Exclude exact departure /


arrival date

© 2010 - 2018 Copyright Liligo Metasearch Technologies 16 of 34


Flight XML feed

Parameters
Parameter Value Description

count Number of results to display Define the maxium number


of offers to return

depairportcode Airport IATA Define the departure airport


code

type all,lowcost,nolowcost Filter for Supplier types

source Define the source of the call Default : inspiration

depmonth 1 to 12 ( optional ) Departure month for the


offers

retmonth 1 to 12 (optional) Use with depmonth


parameter in the same time
to give interval time for
results.

tocontinent destination continent Here are the possible


values : (asia, europe,
africa, south america, north
america, middle east,
central america, pacific,
indian ocean )
Possible to use separated
with “,” for more than one
continents.

tocountry Destination country code Two letter country code.


Possible to use separated
with “,” for more than one
countries.

tocity Destination city name City name with letters.


Example: paris, madrid,
barcelona…
Possible to use separated
with “,” for more than one
cities.

© 2010 - 2018 Copyright Liligo Metasearch Technologies 17 of 34


All destination search For all location search:
Skip the tocity, tocountry
and tocontinent parameters
from query.

apiversion 1 or 2 1 is legacy result pages , 2


is for the widget API

redirectUrl URL of the result page ( Define the url of the page
mandatory for ApiVersion 2) which contains the flight
result page widget encoded
in UTF-8

Example
(deprecated) >
http://{white​_label_domain}/wpartner/views/{partner_identifier}/feeds/flight/destinationFeed.j
sp?count=20&depairportcode=TLS&type=all&source=inspiration&depmonth=11&tocontinent=europe&redi
rectUrl={redirect/resultpageURL}t&apiVersion=2

(current one) >


http://{white_label_domain}/servlet/flightdeals?format=xml&count=20&depairportcode=TLS&type=al
l&source=inspiration&depmonth=11&tocontinent=europe&redirectUrl={redirect/resultpageURL}t&apiV
ersion=2

Hotel XML feed

Parameters
Parameter Value Description

count Number of results to display Define the maxium number


of offers to return

countryCode FR ISO country code

city City name Name of the city to target

format xml Define the output format

template Value provided by Liligo Template applied to the


ouput ( encoded in UTF-8)

apiversion 1 or 2 1 is legacy result pages , 2


is for the widget API

redirectUrl URL of the result page ( Define the url of the page
mandatory for API version 2 which contains the flight
) result page widget encoded

© 2010 - 2018 Copyright Liligo Metasearch Technologies 18 of 34


in UTF-8

Example

http://{white​_label_domain}​/servlet/hotelcitydeals?format=xml&template={liligo_template_to_a
pply}&countryCode=FR&city=lyon&apiVersion=2&redirectUrl={result_page_url}

© 2010 - 2018 Copyright Liligo Metasearch Technologies 19 of 34


Package XML feed

Parameters
Parameter Value Description

count Number of results to display Define the maxium number


of offers to return

from Departure city name Name of the departure city

cat Package sub category sejours,weekend

url Destination to target Continent,country,city


example:
afrique,tunisie,djerba

redirect Url of the result page URL of the package result


page encoded in UTF-8

Example
http://​{white​_label_domain}/wpartner/feeds/package/xmlMultiFeed.jsp?count=15&from=toulouse&cat
=sejours&url=afrique,tunisie,djerba&redirect={result_page_url_encoded}

© 2010 - 2018 Copyright Liligo Metasearch Technologies 20 of 34


Sample codes

Multiple integration code

<script type="text/javascript">
window.liligoWidgets = window.liligoWidgets || [];
liligoWidgets.push(["init", ​"widget-1-id"​, {
widget: "searchForm",
targetDivId: "targetDiv",
options: {
product: "flight"
}
}]);
liligoWidgets.push(["init", ​"widget-2-id"​, {
widget: "searchForm",
targetDivId: "targetDiv2",
options: {
product: "hotel"
}
}]);
</script>
<script src="http://{​white_label_domain​}/servlet/api/widgets/v2.js"></script>
</head>
...
<body>
<h1>Begin of the page</h1>
<h1>TargetDiv</h1>
<div id="targetDiv"></div>
<h1>TargetDiv end</h1>
<h1>TargetDiv2</h1>
<div id="targetDiv2" style="width: 300px"></div>
<h1>TargetDiv2 end</h1>
<script type="text/javascript">
window.liligoWidgets = window.liligoWidgets || [];
liligoWidgets.push(["init", ​"widget-3-id"​, {
widget: "searchForm",
targetDivId: "targetDiv3",
options: {
product: "flight"
}
}]);
</script>
<h1>TargetDiv3</h1>
<div id="targetDiv3" style="width: 300px" ></div>
<h1>TargetDiv3 end</h1>
<h1>End of the page</h1>

© 2010 - 2018 Copyright Liligo Metasearch Technologies 21 of 34


Appendix

Customizable color codes

In this section, you will find the main customizable colors and their impacts on the design elements.

Flight search form

Primary color #C00003 Effects on background color of


icons, checkboxes​ and ​buttons

Secondary color #698694 Effects on ​text colors​ and ​labels

Text dark color #1d1d1d Effects on ​dark text colors

Desktop search form ( width > 768px )

© 2010 - 2018 Copyright Liligo Metasearch Technologies 22 of 34


Tablet search form ( ​width between 320px and 768px )

Mobile search form ( ​width < 320 px)

© 2010 - 2018 Copyright Liligo Metasearch Technologies 23 of 34


Flight result page

Primary color : ​#C00003

See below the main usage of the primary color:

Secondary color: ​ #FFF

Text color for flight time :

Secondary color:​ ​#698694

Text colors, labels ( information text ) :

Secondary color: ​#0074DE

Deeplink, price colors :

© 2010 - 2018 Copyright Liligo Metasearch Technologies 24 of 34


Desktop result page layout Width >1008px

© 2010 - 2018 Copyright Liligo Metasearch Technologies 25 of 34


Tablet result page layout ( width between 768px and 1008px)

© 2010 - 2018 Copyright Liligo Metasearch Technologies 26 of 34


Mobile result page layout ( width < 768px )

© 2010 - 2018 Copyright Liligo Metasearch Technologies 27 of 34


Flight detail view

Desktop detail view layout

Mobile and tablet detail view layout ( width < 768px)

© 2010 - 2018 Copyright Liligo Metasearch Technologies 28 of 34


Flight redirect view

Background color #C00003

Redirect message color #333333

Redirect thanks message #6ba100

Website logo on the top is your own logo

Redirect view (same on all devices)

© 2010 - 2018 Copyright Liligo Metasearch Technologies 29 of 34


Car search form

Primary color #C00003 Effects on background color of ​icons,


checkboxes​ and ​buttons

Secondary color #698694 Effects on ​text colors​ and ​labels

Text dark color #1d1d1d Effects on ​dark text colors

Width > 768px (Desktop view)

320px > Width < 768px (Tablet view)

© 2010 - 2018 Copyright Liligo Metasearch Technologies 30 of 34


320px < Width (Mobile view)

© 2010 - 2018 Copyright Liligo Metasearch Technologies 31 of 34


Car result page

Primary color #C00003 Effects on background color of


icons, checkboxes​ and ​buttons

Secondary color #698694 Effects on ​text colors​ and ​labels

Text dark color #1d1d1d Effects on ​dark text colors

Deeplink and price colors #0074DE Effects on ​deeplinks

Width > 768px (Desktop view)

© 2010 - 2018 Copyright Liligo Metasearch Technologies 32 of 34


Width < 600px (Mobile view)

Result page Filters

© 2010 - 2018 Copyright Liligo Metasearch Technologies 33 of 34


Car redirect page

Background color #C00003

Redirect message color #698694

Redirect thanks message #0074DE

Website logo on the top is your own logo

Redirect view (same on all devices)

© 2010 - 2018 Copyright Liligo Metasearch Technologies 34 of 34

Das könnte Ihnen auch gefallen