API
The API (Application Programming Interface) of Buscapé is a set of functions and standards for creating custom applications, who need to use the database of products, offers and services offered by Buscapé.
How it works?
To integrate the API Buscapé you must first obtain an ID for your application, to be used on all requests made to a service that is requested. It is through this ID is made to measure the performance of your application.
All services using REST technology for the treatment of requests. This way you can easily build a URL to run in your browser, command line or code.
The URL is constituted as follows:
Where:
- HostName: main URL of the webservice
- ServiceName: name of service
- ApplicationId: Application ID
- CountryCode: Country code
- Parameters: Parameters of service
The default format of response is in XML, but there is the option of using JSON, which in turn helps the integration of technology with JavaScript and Flash easily and extremely agile.
Format Request
The REST is the only technology used in all the services API Buscapé in the treatment of requests.
Overview
Representational State Transfer (Representational State Transfer) or only REST is a software engineering technique for distributed systems, which describes a simple web interface that uses XML, HTTP, JSON or plain text, without additional abstractions of standards-based protocols to exchange message as SOAP.
Example request using REST
In the URL above we use the service findProductList Buscapé API, which allows you to search through a list of products through the end of the class ID and / or a set of keywords. Application_id The term refers to the ID of your application registered for the API requests Buscapé and the parameter keyword is the keyword searched between products.
Through this URL request, the API returns an XML Buscapé you with a list of products with the keyword used.
Return Formats
You can use XML and / or formats like JSON API return the Buscapé.
Overview
XML (eXtensible Markup Language) is the standard markup language API in return Buscapé, because with it the developer can handle the data, regardless of programming language. We also have the option to use JSON ( JavaScript Object Notation) which is a subset of JavaScript object notation, but their use alone does not require JavaScript.
Example of return in XML format
Using the service findProductList API Buscapé, seek a list of 77 products in the category that is related to cell phones.
With the above request, the following XML is returned:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
564771466d477a4458664d3d
1.0.0.0
http://bws-apps.buscape.com/mobile/update
2010-10-19T14:09:05.997
2
success
0
success
Celular e Smartphone
LG GT350 Cookie Messenger GSM Desbloqueado
LG GT350 Cookie Messenger Desbloqueado
399.00
399.00
36
8.4
-
3.15 MP
-
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
Viva Voz
-
MicroSD
-
Bluetooth
EDGE
GPRS
Micro-USB
WAP
LG GS290 Cookie Plus GSM Desbloqueado
LG GS290 Cookie Plus Desbloqueado
299.99
722.58
14
9.0
-
2.0 MP
-
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
Viva Voz
-
MicroSD
-
Bluetooth
EDGE
Fone de Ouvido
GPRS
USB
WAP
LG GX200 GSM Desbloqueado
LG GX200 Desbloqueado
289.00
429.00
74
7.2
-
1.3 MP
-
Dual Chip
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
Viva Voz
-
MicroSD
-
Bluetooth
Fone de Ouvido
GPRS
USB
WAP
Samsung Corby S3650 GSM Desbloqueado
Samsung Corby S3650 Desbloqueado
349.00
818.98
49
8.8
-
2.0 MP
-
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
Viva Voz
-
MicroSD
-
Bluetooth
EDGE
Fone de Ouvido
GPRS
USB
WAP
Samsung B7320 GSM Desbloqueado
Samsung B7320 Desbloqueado
649.00
939.00
8
6.0
-
3.15 MP
-
Comando de Voz
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
Videoconferência
Visualizador de Documentos
Viva Voz
-
Sim
-
MicroSD
-
Bluetooth
EDGE
Fone de Ouvido
GPRS
USB
WAP
Wi-Fi
Nokia X3 GSM Desbloqueado
Nokia X3 Desbloqueado
379.00
661.50
20
9.0
-
3.2 MP
-
Comando de Voz
Grava Video
Gravador de Voz
Java
Media Player
MP3 Player
Rádio
Reproduz Video
Viva Voz
-
MicroSD
-
Bluetooth
EDGE
Fone de Ouvido
GPRS
Micro-USB
WAP
Samsung S5620 Star 3G GSM Desbloqueado
Samsung S5620 Star 3G Desbloqueado
499.99
818.98
19
8.8
-
3.2 MP
-
Grava Video
Gravador de Voz
Java
Media Player
MP3 Player
Rádio
Reproduz Video
Visualizador de Documentos
Viva Voz
-
Sim
-
MicroSD
-
Bluetooth
EDGE
Fone de Ouvido
GPRS
USB
WAP
Wi-Fi
Samsung B5722 GSM Desbloqueado
Samsung B5722 Desbloqueado
605.00
799.00
11
9.4
-
3.15 MP
-
Dual Chip
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
Viva Voz
-
MicroSD
-
Bluetooth
EDGE
GPRS
USB
WAP
LG GM600 GSM Desbloqueado
LG GM600 Desbloqueado
439.00
738.24
49
8.2
-
3.2 MP
-
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
TV
Viva Voz
-
Sim
-
Bluetooth
EDGE
Fone de Ouvido
GPRS
USB
WAP
Nokia E63 GSM Desbloqueado
Nokia E63 Desbloqueado
497.00
1399.00
24
8.6
-
2.0 MP
-
Comando de Voz
Grava Video
Gravador de Voz
Java
Loja Online de Aplicativos
Media Player
MP3 Player
Rádio
Reproduz Video
Visualizador de Documentos
Viva Voz
-
Sim
-
MicroSD
-
Bluetooth
EDGE
Fone de Ouvido
GPRS
Micro-USB
WAP
Wi-Fi
Motorola i776 Iden Nextel
Motorola i776 Nextel
290.00
499.00
17
7.6
-
0.3 MP
-
Comando de Voz
Java
LG GX500 GSM Desbloqueado
LG GX500 Desbloqueado
623.00
829.00
14
8.4
-
3.2 MP
-
Dual Chip
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
Viva Voz
-
MicroSD
-
Bluetooth
EDGE
Fone de Ouvido
GPRS
Micro-USB
WAP
Wi-Fi
Samsung C3300 GSM Desbloqueado
Samsung C3300 Desbloqueado
299.00
379.00
4
9.0
-
1.3 MP
-
Grava Video
Java
Media Player
MP3 Player
Reproduz Video
Viva Voz
-
MicroSD
-
Bluetooth
EDGE
GPRS
WAP
Samsung B7300 Omnia Lite GSM Desbloqueado
Samsung B7300 Omnia Lite Desbloqueado
799.99
1459.90
3
10.0
-
3.15 MP
-
Grava Video
Gravador de Voz
Java
Media Player
MP3 Player
Rádio
Reproduz Video
Videoconferência
Visualizador de Documentos
Viva Voz
-
Sim
-
MicroSD
-
Bluetooth
EDGE
GPRS
Micro-USB
Wi-Fi
LG Cookie KP570 GSM Desbloqueado
LG Cookie KP570 Desbloqueado
310.00
699.00
419
9.0
-
3.0 MP
-
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
Visualizador de Documentos
Viva Voz
-
Não
-
MicroSD
-
Bluetooth
Fone de Ouvido
USB
WAP
Samsung Star S5230 GSM Desbloqueado
Samsung Star S5230 Desbloqueado
399.00
799.90
127
8.8
-
3.2 MP
-
Grava Video
Gravador de Voz
Java
MP3 Player
Rádio
Reproduz Video
Visualizador de Documentos
Viva Voz
-
Não
-
MicroSD
-
Bluetooth
EDGE
Fone de Ouvido
GPRS
USB
WAP
Example Return JSON format
To use JSON as a callback method of your application, you should use the &format=json parameter to tell the webservice to return the format requested.
We may also, in JSON format, provide the name of a JavaScript function to run once the webservice answer.
The parameter &callBack=_cb tells the webservice to return _cb("json response"). Use this parameter does not require the developer to use the function eval("json response") to generate the JavaScript object. With this, the developer avoids security issues related to using eval() if the content of the response is not reliable.
Below is a graphical representation of an application using JSON callback function:
- HTML executes the javascript.
- JavaScript makes a service request category list.
- Service receives the request and search the list of categories of the Shuffle.
- Service returns the list of categories in JSON format to the javascript.
- Javascript _cb performs the function (obj).
- _cb Function (obj) returns an HTML table with the list of names of categories.
Content from other countries
Buscapé The API offers the option to return content of a given country, provided it is supported by the API and the service used.
Below is the format of the URL request to use:
Instead of <country_code> put the country code you want. See below for all countries supported by the API.
If no country is given, the default contents will be in Brazil.
Services
-
Category List
Search for a category list of products or offers. -
List of products
Search products by one or more keywords or category ID. -
List all offers
Search offers a certain product, filtering for evaluation of the store, price or popularity. -
List of popular products
Search the most popular products of Buscapé -
User rating
Search the evaluations of users about a particular product. -
Technical details of a product
Find technical details about a particular product. -
Details of a store or company
Search contacts and addresses for a specific store or company.
Important Information
- The use of UTF-8 support for the accents are displayed correctly.
- For security and performance, all applications are limited to 2,000 queries per IP on a 24 hour period..
Kit API / Wrapper
See our Kit / Wrapper for PHP development, .NET to help integrate their applications to the API Buscapé.
