product crawler

Manual
Page 1 of 8
PRODUCT CRAWLER
Manual
ALTILIA S.r.l.
Sede opertiva: Piazza Vermicelli – 87036 Rende (CS), Italy
Sede legale: Via A. Volta, 41 – 87036 Rende (CS), Italy
Tel & Fax: +39 0984 494277
E-mail:
[email protected]
Web:
www.altilagroup.com
Used by permission. All rights reserved.
P. IVA e C. Fiscale: 10780921002 Reg. Imprese Cosenza
R.E.A. Cosenza n°209625 - Cap. Soc. versato € 17.395,56
22/04/2014
Manual
PRODUCT CRAWLER
Page 2 of 8
TABLE OF CONTENTS
1
APP documentation ................................................................................... 3
1.1 HOW IT WORKS ........................................ Errore. Il segnalibro non è definito.
1.2 Input data ................................................ Errore. Il segnalibro non è definito.
1.3 Output data ............................................. Errore. Il segnalibro non è definito.
1.4 Basic workflow example ........................... Errore. Il segnalibro non è definito.
2
API documentation .................................................................................... 4
ALTILIA S.r.l.
Sede operativa: Piazza Vermicelli – 87036 Rende (CS), Italy
Sede legale: Via A. Volta, 41 – 87036 Rende (CS), Italy
Tel & Fax: +39 0984 494277
E-mail:
[email protected]
Web:
www.altilagroup.com
Used by permission. All rights reserved.
P. IVA e C. Fiscale: 10780921002 Reg. Imprese Cosenza
R.E.A. Cosenza n°209625 - Cap. Soc. versato € 17.395,56
22/04/2014
Manual
PRODUCT CRAWLER
1
Page 3 of 8
APP DOCUMENTATION
The Product Crawler API service allows to extract all products in web pages reached by
navigating menus on the base of keywords chosen by users. The service provides in output
extracted records as a JSON object.
The Product Crawler GUI is not available at the moment.
You can use it by Product Crawler API services (see next section).
ALTILIA S.r.l.
Sede operativa: Piazza Vermicelli – 87036 Rende (CS), Italy
Sede legale: Via A. Volta, 41 – 87036 Rende (CS), Italy
Tel & Fax: +39 0984 494277
E-mail:
[email protected]
Web:
www.altilagroup.com
Used by permission. All rights reserved.
P. IVA e C. Fiscale: 10780921002 Reg. Imprese Cosenza
R.E.A. Cosenza n°209625 - Cap. Soc. versato € 17.395,56
22/04/2014
PRODUCT CRAWLER
2
Manual
Page 4 of 8
API DOCUMENTATION
The Product Crawler API service allows to extract all products in web pages reached by
navigating menus on the base of keywords chosen by users. The service provides in output
extracted records as a JSON object.
2.1 HOW IT WORKS
To consume the Product Crawler API, you only need to specify the url of an e-commerce web
site and one or more menu names separated by comma.
In the following example we test this service on the walmart.com web site and we wont all
products in the “desktops” category; the service returns the results shown in the last figure
(visual and json format):
Figure 1 - example of input data
ALTILIA S.r.l.
Sede operativa: Piazza Vermicelli – 87036 Rende (CS), Italy
Sede legale: Via A. Volta, 41 – 87036 Rende (CS), Italy
Tel & Fax: +39 0984 494277
E-mail:
[email protected]
Web:
www.altilagroup.com
Used by permission. All rights reserved.
P. IVA e C. Fiscale: 10780921002 Reg. Imprese Cosenza
R.E.A. Cosenza n°209625 - Cap. Soc. versato € 17.395,56
22/04/2014
Manual
PRODUCT CRAWLER
Page 5 of 8
Figure 2 - example of visual output data
ALTILIA S.r.l.
Sede operativa: Piazza Vermicelli – 87036 Rende (CS), Italy
Sede legale: Via A. Volta, 41 – 87036 Rende (CS), Italy
Tel & Fax: +39 0984 494277
E-mail:
[email protected]
Web:
www.altilagroup.com
Used by permission. All rights reserved.
P. IVA e C. Fiscale: 10780921002 Reg. Imprese Cosenza
R.E.A. Cosenza n°209625 - Cap. Soc. versato € 17.395,56
22/04/2014
Manual
PRODUCT CRAWLER
Page 6 of 8
The following is the JSON output format:
{
"categories":[
{
"categoryName":"
<h1><b>Desktops</b></h1>
",
"category":[
{
"record":"<!-- TEST 1--><!-99752068-06c5-4d70-bb25-816bc8a693fb
2a426753-4817-4217-aa2c-3146b7f4ba7b-->
--><!--
<div class="\"quickLook\"">
<div
id="\"ilm_24766511\""
style="0display:
none;"
onclick="\"WALMART.quicklook.LoadQuickView('24766511')\"">
name="\"modal\""
<div class="\"BlueBtn\"" id="\"img_ilm_24766511\"" div="">
<p class="\"clear\""><!-- --></p>
"
},
{
"record":"<!-- TEST 2--> …. and so on …
}
]
}
]
}
2.2 HOW TO USE IT
To consume the Product Crawler API, you will only need to perform a HTTP POST request on the
following endpoint:
http://mantra13dev-prod.apigee.net/mantra-services/product-crawler
sending following arguments in a JSON message:
ALTILIA S.r.l.
Sede operativa: Piazza Vermicelli – 87036 Rende (CS), Italy
Sede legale: Via A. Volta, 41 – 87036 Rende (CS), Italy
Tel & Fax: +39 0984 494277
E-mail:
[email protected]
Web:
www.altilagroup.com
Used by permission. All rights reserved.
P. IVA e C. Fiscale: 10780921002 Reg. Imprese Cosenza
R.E.A. Cosenza n°209625 - Cap. Soc. versato € 17.395,56
22/04/2014
Manual
PRODUCT CRAWLER
Page 7 of 8
Arguments
Description
url
You can specify the url of an e-commerce web
page.
keyWords
Set of menu names/menu entries to browse.
accessToken
Access Token.
The following example illustrates the service request and response in JSON format:
Request
{
“url":"type the url of the single article you want to process",
"keyWords":"menu entries/menu names to browse",
"accessToken":"your access token"
}
Note: Use 'application/json' as header ContentType
Response
{"categories":
[{"category":
[{"categoryName":""},
{"record":""},
{"record":""},
.
.
.
{"record":""}
]}
[{"category":
[{"categoryName":""},
{"record":""},
{"record":""},
.
.
.
{"record":""}
]}
]
ALTILIA S.r.l.
Sede operativa: Piazza Vermicelli – 87036 Rende (CS), Italy
Sede legale: Via A. Volta, 41 – 87036 Rende (CS), Italy
Tel & Fax: +39 0984 494277
E-mail:
[email protected]
Web:
www.altilagroup.com
Used by permission. All rights reserved.
P. IVA e C. Fiscale: 10780921002 Reg. Imprese Cosenza
R.E.A. Cosenza n°209625 - Cap. Soc. versato € 17.395,56
22/04/2014
Manual
PRODUCT CRAWLER
Page 8 of 8
}
You can see the WADL to the following address:
http://mantra13dev-prod.apigee.net/mantra-services/product-crawler
* Note: domain name and port values will be provided with the contract of the service.
For more information about how to use Product Crawler API in your application, send us a
message to [email protected].
ALTILIA S.r.l.
Sede operativa: Piazza Vermicelli – 87036 Rende (CS), Italy
Sede legale: Via A. Volta, 41 – 87036 Rende (CS), Italy
Tel & Fax: +39 0984 494277
E-mail:
[email protected]
Web:
www.altilagroup.com
Used by permission. All rights reserved.
P. IVA e C. Fiscale: 10780921002 Reg. Imprese Cosenza
R.E.A. Cosenza n°209625 - Cap. Soc. versato € 17.395,56
22/04/2014