.NET Wrapper
Apiki_Buscape_API class was created to help in developing applications using web services API provided by Buscapé.
How it works?
The class Apiki_Buscape_API pre-configures your application to integrate with the API Buscapé, ie, it facilitates the integration and speeds development of applications.
How to use?
To use the class Apiki_Buscape_API you must follow these steps:
- Download the class Apiki_Buscape_API.
- Add a reference to it in your application.
- Instantiate the class.
- Use your body set up to call the methods of the class.
Methods
The class contains methods Apiki_Buscape_API based on each service provided by the API Buscapé.
-
FindCategoryList
Search for a category list of products or offers. -
FindOfferList
Search all offers of a particular product, filtering for APPRAISAL store, price or popularity. -
FindProductList
Search for products by one or more keywords or category ID. -
TopProducts
Search the most popular products of Buscapé -
ViewProductDetails
Search the technical details of a particular product. -
ViewSellerDetails
Search contacts and addresses for a specific store or company. -
ViewUserRatings
Search the evaluations of users of a particular product
FindCategoryList
Search method categories and allows you to display information relating to them.
The method has 3 (three) parameters. To suppress one of them, pass an empty string or an integer value 0 (zero).
| Parameters array | Type | Description |
|---|---|---|
| categoryId | int | Category ID |
| keyword | string | Keywords |
| callback | string | Callback function to be executed as if you're using JSON return format |
Note: To retrieve a list of root classes, please categoryId = 0.
Example
// Instantiate class Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);
// Gets the method's return
string retorno = bp.FindCategoryList(77, "celular,nokia", string.Empty);
To learn about the data and parameters returned by this method, see the documentation on the service.
FindOfferList
Search method a list of offerings.
The method has 5 (five) parameters. To suppress one of them, pass an empty string or an integer value 0 (zero).
| Parameters array | Type | Description |
|---|---|---|
| categoryId | int | Category ID |
| keyword | string | Keywords |
| productId | int | Product ID |
| barcode | string | Barcode Product |
| callback | string | Callback function to be executed as if you're using JSON return format |
Note: At least one of the search parameters should be informed. The parameters 'categoryId' and 'keyword' may be used together to search keywords in a particular category.
Example
// Instantiate class Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);
// Gets the method's return
string retorno = bp.FindOfferList(0, string.Empty, 10500, string.Empty, string.Empty);
To learn about the data and parameters returned by this method, see the documentation on the service.
FindProductList
Method searches for products and allows you to get a list of products using the unique ID of the final category, a set of keywords or both.
The method has 3 (three) parameters. To suppress one of them, pass an empty string or an integer value 0 (zero).
| Parameters array | Type | Description |
|---|---|---|
| categoryId | int | Category ID |
| keyword | string | Keywords |
| callback | string | Callback function to be executed as if you're using JSON return format |
Note: At least one of the search parameters should be informed. The parameters 'categoryId' and 'keyword' may be used together to search keywords in a particular category.
Example
// Instantiate class Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "json", true);
// Gets the method's return
string retorno = bp.FindProductList(0, "celular", "NomeDaFuncao");
To learn about the data and parameters returned by this method, see the documentation on the service.
TopProducts
Method returns the most popular products of cod.
The method has one (1) parameter. To suppress it passes an empty string.
| Parameters array | Type | Description |
|---|---|---|
| callback | string | Callback function to be executed as if you're using JSON return format |
Example
// Instantiate class Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);
// Gets the method's return
string retorno = bp.TopProducts(string.empty);
To learn about the data and parameters returned by this method, see the documentation on the service.
ViewProductDetails
Method returns the technical details of a product.
The method has two (2) parameters. To cancel the callback pass an empty string.
| Parameters array | Type | Description |
|---|---|---|
| productId | int | Product ID |
| callback | string | Callback function to be executed as if you're using JSON return format |
Note: The product ID is required.
Exemple
// Instantiate class Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);
// Gets the method's return
string retorno = bp.ViewProductDetails(1000, string.empty);
To learn about the data and parameters returned by this method, see the documentation on the service.
ViewSellerDetails
Method returns the details of the store or company
The method has two (2) parameters. To cancel the callback pass an empty string.
| Parameters array | Type | Description |
|---|---|---|
| sellerId | int | Store / business ID |
| callback | string | Callback function to be executed as if you're using JSON return format |
Note: The ID of the store / company is required.
Exemple
// Instantiate class Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);
// Gets the method's return
string retorno = bp.ViewSellerDetails(335525, string.empty);
To learn about the data and parameters returned by this method, see the documentation on the service.
ViewUserRatings
Method returns the evaluations of users about a particular product.
The method has two (2) parameters. To cancel the callback pass an empty string.
| Parameters array | Type | Description |
|---|---|---|
| productId | int | Product ID |
| callback | string | Callback function to be executed as if you're using JSON return format |
Note: The product ID is required.
Exemple
// Instantiate class Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);
// Gets the method's return
string retorno = bp.ViewUserRatings(1000, string.empty);
To learn about the data and parameters returned by this method, see the documentation on the service.
