Classe Apiki_Buscape_API

Descrição

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 ?

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

mkdir buscape-php

Faça um clone do repositório

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

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

require_once 'Apiki_Buscape_API.php';

$applicationID  = '564771466d477a4458664d3d';
$sourceID       = '';

$objBuscaPeApi = new Apiki_Buscape_API( $applicationID, $sourceID );
$objBuscaPeApi->findCategoryList();

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

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

string Apiki_Buscape_API::createSource( array $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 array 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.

Métodos de Consulta Disponíveis

string Apiki_Buscape_API::findCategoryList( array $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 array 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.

string Apiki_Buscape_API::findOfferList( array $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 array 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.

string Apiki_Buscape_API::findProductList( array $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 array 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.

string Apiki_Buscape_API::topProducts( array $args )

Método retorna os produtos mais populares do BuscaPé. Todos os parâmetros necessários para a busca são informados em um array 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.

string Apiki_Buscape_API::viewProductDetails( array $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 array 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.

string Apiki_Buscape_API::viewSellerDetails( array $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 array 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.

string Apiki_Buscape_API::viewUserRatings( array $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 array 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 Apiki_Buscape_API::getApplicationId()

Retorna o Id da aplicação.

Veja também Apiki_Buscape_API::setApplicationId( string $applicationId )

string Apiki_Buscape_API::getCountryCode()

Retorna o código do país.

Veja também Apiki_Buscape_API::setCountryCode( string $countryCode )

string Apiki_Buscape_API::getEnvironment()

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

Veja também Apiki_Buscape_API::setSandbox()

string Apiki_Buscape_API::getFormat()

Retorna o formato de retorno (xml ou json).

Veja também Apiki_Buscape_API::setFormat( string $format )

string Apiki_Buscape_API::getSourceId()

Retorna o Source ID.

Veja também Apiki_Buscape_API::setSourceId( string $sourceId )

void Apiki_Buscape_API::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 Apiki_Buscape_API::getApplicationId()

void Apiki_Buscape_API::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 Apiki_Buscape_API::getCountryCode()

void Apiki_Buscape_API::setFormat( string $format )

Define o formato de retorno.

• string $format Formato do retorno, pode ser xml ou json

Veja também Apiki_Buscape_API::getFormat()

void Apiki_Buscape_API::setSandbox( void )

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

Veja também Apiki_Buscape_API::getEnvironment()

void Apiki_Buscape_API::setSourceId( string $sourceId )

Define o sourceId

• string $sourceId O sourceId

Veja também Apiki_Buscape_API::getSourceId()