buscape-js v1.0.0

Classe BuscapeAPI

Descrição

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

Como funciona ?

A classe BuscapeAPI 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 ?

Defina um diretório para ela em sua aplicação.

mkdir buscape-js

Faça um clone do repositório

git clone https://github.com/buscapedev/buscape-js.git

Instancie a classe. Use sua instância criada para chamar os métodos da classe.

var objBuscaPeApi = new BuscapeAPI( applicationID , sourceID );
		
objBuscaPeApi.setSandbox();
objBuscaPeApi.findCategoryList( { categoryId : 0 } );

Para mais informações acesse o guia do desenvolvedor BuscaPé

Métodos de Criação de código Lomadee

String BuscapeAPi::createSource( Object args )

Serviço utilizado somente na integração do Aplicativo com o Lomadee.

Dentro do fluxo de integração, o aplicativo utiliza esse serviço para criar sourceId (código) para o Publisher que deseja utiliza-lo. Os parâmetros necessários neste serviço são informados pelo próprio Lomadee ao aplicativo.

No ambiente de homologação sandbox, os valores dos parâmetros podem ser fictícios pois neste ambiente este serviço retornará sempre o mesmo sourceId para os testes do Developer.

Todos os parâmetros necessários para a busca são informados em um objeto que deve ser passado para o método, são eles:

• sourceName Nome do código.
• publisherId ID do publisher.
• siteId ID do site selecionado pelo publisher.
• campaignList Lista de IDs das campanhas separados por vírgula.
• token Token utilizado para validação da requisição.

Recuperação dos dados

void BuscapeAPI::receiveContent( Object result )

O retorno de todas as chamadas serão recebidos pelo método BuscapeAPI.receiveContent que receberá como parâmetro o objeto JSON retornado pela API.

var objBuscaPeApi = new BuscapeAPI( applicationID , sourceID );

objBuscaPeApi.findCategoryList( { categoryId : 0 } );
objBuscaPeApi.receiveContent = function( result ) {
	alert( result.details.message );
}; 

Métodos de Consulta Disponíveis

String BuscapeAPi::findCategoryList( Object args )

Método faz busca de categorias, permite que você exiba informações relativas às categorias. É possível obter categorias, produtos ou ofertas informando apenas um ID de categoria.

Todos os parâmetros necessários para a busca são informados em um objeto que deve ser passado para o método, são eles:

• categoryId Id da categoria.
• keyword Palavra-chave buscada entre as categorias.
• callback Função de retorno a ser executada caso esteja usando o método JSON como retorno.

Se não for informado nenhum dos parâmetros, a função retornará por padrão uma lista de categorias raiz, de id 0.

void BuscapeAPi::findOfferList( Object args , Boolean lomadee )

Método busca uma lista de ofertas. É possível obter a lista de ofertas informando o ID do produto.

Todos os parâmetros necessários para a busca são informados em um objeto que deve ser passado para o método, são eles:

• categoryId Id da categoria.
• keyword Palavra-chave buscada entre as categorias.
• productId Id do produto.
• barcode Código de barras do produto.
• callback Função de retorno a ser executada caso esteja usando o método JSON como retorno.

O parâmetro lomadee é um boolean que indicará se será utilizada a API Lomadee, por padrão esse valor é false.

Pelo menos um dos parâmetros de pesquisa devem ser informados para o retorno da função. Os parâmetros categoryId e keyword podem ser usados em conjunto.

void BuscapeAPi::findProductList( Object args , Boolean lomadee )

Método permite que você busque uma lista de produtos únicos utilizando o id da categoria final ou um conjunto de palavras-chaves ou ambos. Todos os parâmetros necessários para a busca são informados em um objeto que deve ser passado para o método, são eles:

• categoryId Id da categoria.
• keyword Palavra-chave buscada entre as categorias.
• callback Função de retorno a ser executada caso esteja usando o método JSON como retorno.

Pelo menos um dos parâmetros, categoryID ou keyword são requeridos para funcionamento desta função. Os dois também podem ser usados em conjunto. Ou seja, podemos buscar uma palavra-chave em apenas uma determinada categoria.

O parâmetro lomadee é um boolean que indicará se será utilizada a API Lomadee, por padrão esse valor é false.

void BuscapeAPi::topProducts( Object args )

Método retorna os produtos mais populares do BuscaPé. Todos os parâmetros necessários para a busca são informados em um objeto que deve ser passado para o método, são eles:

• callback Função de retorno a ser executada caso esteja usando o método JSON como retorno.

void BuscapeAPi::viewProductDetails( Object args )

Função retorna os detalhes técnicos de um determinado produto. Todos os parâmetros necessários para a busca são informados em um objeto que deve ser passado para o método, são eles:

• productId Id do produto (requerido).
• callback Função de retorno a ser executada caso esteja usando o método json como retorno.

void BuscapeAPi::viewSellerDetails( Object args )

Função retorna os detalhes da loja/empresa como: endereços, telefones de contato etc... Todos os parâmetros necessários para a busca são informados em um objeto que deve ser passado para o método, são eles:

• sellerId Id da loja/empresa (requerido).
• callback Função de retorno a ser executada caso esteja usando o método JSON como retorno.

void BuscapeAPi::viewUserRatings( Object args )

Método retorna as avaliações dos usuários sobre um determinado produto. Todos os parâmetros necessários para a busca são informados em um objeto que deve ser passado para o método, são eles:

• productId Id do produto (requerido).
• callback Função de retorno a ser executada caso esteja usando o método JSON como retorno.

Getters, Setters e Métodos auxiliares

String BuscapeAPi::getApplicationId()

Retorna o Id da aplicação.

Veja também BuscapeAPI::setApplicationId( String applicationId )

String BuscapeAPi::getCountryCode()

Retorna o código do país.

Veja também BuscapeAPI::setCountryCode( String countryCode )

String BuscapeAPi::getEnvironment()

Retorna o ambiente de integração (bws para produção e sandbox para testes).

Veja também BuscapeAPI::setSandbox()

String BuscapeAPi::getFormat()

Retorna o formato de retorno (xml ou json).

Veja também BuscapeAPI::setFormat( String format )

String BuscapeAPi::getSourceId()

Retorna o Source ID.

Veja também BuscapeAPI::setSourceId( String sourceId )

void BuscapeAPI::setApplicationId( String applicationId )

Define o Id da aplicação.

• String applicationId ID da aplicação registrado no BuscaPé.

Para obter um ID de aplicação você precisará fazer seu registro

Veja também BuscapeAPI::getApplicationId()

void BuscapeAPI::setCountryCode( String countryCode )

Define o código do país.

• String countryCode_ Código do país, pode ser um dos abaixo: * AR Para Argentina * BR Para Brasil * CL Para Chile * CO Para Colômbia * MX Para México * PE Para Peru * VE__ Para Venezuela

Veja também BuscapeAPI::getCountryCode()

void BuscapeAPI::setFormat( String format )

Define o formato de retorno.

• String format Formato do retorno, pode ser xml ou json

Veja também BuscapeAPI::getFormat()

void BuscapeAPI::setSandbox( void )

Define se a integração vai ser feita no sandbox ou no ambiente de produção.

Veja também BuscapeAPI::getEnvironment()

void BuscapeAPI::setSourceId( String sourceId )

Define o sourceId

• String sourceId O sourceId

Veja também BuscapeAPI::getSourceId()