.NET

A classe Apiki_Buscape_API foi criada para ajudar no desenvolvimento de aplicações usando os webservices disponibilizados pela API do Buscapé.

Como funciona?

A classe Apiki_Buscape_API pré-configura sua aplicação para uma integração com a API do Buscapé, ou seja, ela facilita a integração e agiliza o desenvolvimento das aplicações.

Como usar?

Para usar a classe Apiki_Buscape_API é necessário seguir os passos abaixo:

  1. Faça o download da classe Apiki_Buscape_API.
  2. Adicione uma referência para ela na sua aplicação.
  3. Instancie a classe.
  4. Use sua instância criada para chamar os métodos da classe.

Métodos

A classe Apiki_Buscape_API contém métodos baseados em cada serviço disponibilizado pela API do Buscapé.

FindCategoryList

Método busca categorias e permite que sejam exibidas informações relativas a elas.

O método possui 3 (três) parâmetros. Para suprimir um deles, passe uma string vazia ou um inteiro de valor 0 (zero).

Parâmetros do array Tipo Descrição
categoryId int ID da categoria
keyword string Palavras-chaves
callback string Função de retorno a ser executada caso esteja usando JSON como formato de retorno

Nota: Para recuperar uma lista de categorias raiz, informe o categoryId = 0.

Exemplo

// Instancia a classe Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);

// Obtém o retorno do método
string retorno = bp.FindCategoryList(77, "celular,nokia", string.Empty);
            

Para saber sobre os dados e parâmetros retornados por este método, consulte a documentação sobre o serviço.

FindOfferList

Método busca uma lista de ofertas.

O método possui 5 (cinco) parâmetros. Para suprimir um deles, passe uma string vazia ou um inteiro de valor 0 (zero).

Parâmetros do array Tipo Descrição
categoryId int ID da categoria
keyword string Palavras-chaves
productId int ID do produto
barcode string Código de barras do produto
callback string Função de retorno a ser executada caso esteja usando JSON como formato de retorno

Nota: Pelo menos um dos parâmetros de pesquisa deve ser informado. Os parâmetros 'categoryId' e 'keyword' podem ser usados em conjunto para buscar palavras-chaves em uma determinada categoria.

Exemplo

// Instancia a classe Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);

// Obtém o retorno do método
string retorno = bp.FindOfferList(0, string.Empty, 10500, string.Empty, string.Empty);
            

Para saber sobre os dados e parâmetros retornados por este método, consulte a documentação sobre o serviço.

FindProductList

Método procura produtos e permite que você obtenha uma lista de produtos únicos utilizando o ID da categoria final, um conjunto de palavras-chaves ou ambos.

O método possui 3 (três) parâmetros. Para suprimir um deles, passe uma string vazia ou um inteiro de valor 0 (zero).

Parâmetros do array Tipo Descrição
categoryId int ID da categoria
keyword string Palavras-chaves
callback string Função de retorno a ser executada caso esteja usando JSON como formato de retorno

Nota: Pelo menos um dos parâmetros de pesquisa deve ser informado. Os parâmetros 'categoryId' e 'keyword' podem ser usados em conjunto para buscar palavras-chaves em uma determinada categoria.

Exemplo

// Instancia a classe Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "json", true);

// Obtém o retorno do método
string retorno = bp.FindProductList(0, "celular", "NomeDaFuncao");
            

Para saber sobre os dados e parâmetros retornados por este método, consulte a documentação sobre o serviço.

TopProducts

Método retorna os produtos mais populares do Buscapé.

O método possui 1 (um) parâmetro. Para suprimí-lo passe uma string vazia.

Parâmetros do array Tipo Descrição
callback string Função de retorno a ser executada caso esteja usando JSON como formato de retorno

Exemplo

// Instancia a classe Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);

// Obtém o retorno do método
string retorno = bp.TopProducts(string.empty);
            

Para saber sobre os dados e parâmetros retornados por este método, consulte a documentação sobre o serviço.

ViewProductDetails

Método retorna os detalhes técnicos de um produto.

O método possui 2 (dois) parâmetros. Para suprimir o de callback passe uma string vazia.

Parâmetros do array Tipo Descrição
productId int ID do produto
callback string Função de retorno a ser executada caso esteja usando JSON como formato de retorno

Nota: O ID do produto é obrigatório.

Exemplo

// Instancia a classe Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);

// Obtém o retorno do método
string retorno = bp.ViewProductDetails(1000, string.empty);
            

Para saber sobre os dados e parâmetros retornados por este método, consulte a documentação sobre o serviço.

ViewSellerDetails

Método retorna os detalhes da loja ou empresa

O método possui 2 (dois) parâmetros. Para suprimir o de callback passe uma string vazia.

Parâmetros do array Tipo Descrição
sellerId int ID da loja/empresa
callback string Função de retorno a ser executada caso esteja usando JSON como formato de retorno

Nota: O ID da loja/empresa é obrigatório.

Exemplo

// Instancia a classe Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);

// Obtém o retorno do método
string retorno = bp.ViewSellerDetails(335525, string.empty);
            

Para saber sobre os dados e parâmetros retornados por este método, consulte a documentação sobre o serviço.

ViewUserRatings

Método retorna as avaliações dos usuários sobre um determinado produto.

O método possui 2 (dois) parâmetros. Para suprimir o de callback passe uma string vazia.

Parâmetros do array Tipo Descrição
productId int ID do produto
callback string Função de retorno a ser executada caso esteja usando JSON como formato de retorno

Nota: O ID do produto é obrigatório.

Exemplo

// Instancia a classe Apiki_Buscape_API
Apiki_Buscape_API.Apiki_Buscape_API bp = new Apiki_Buscape_API.Apiki_Buscape_API(applicationID, "BR", "xml", true);

// Obtém o retorno do método
string retorno = bp.ViewUserRatings(1000, string.empty);
            

Para saber sobre os dados e parâmetros retornados por este método, consulte a documentação sobre o serviço.

Topo