PHPackages                             olavocn/buscape-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. olavocn/buscape-php

AbandonedArchivedLibrary[API Development](/categories/api)

olavocn/buscape-php
===================

016PHP

Since May 24Pushed 11y ago1 watchersCompare

[ Source](https://github.com/olavocneto/buscape-php)[ Packagist](https://packagist.org/packages/olavocn/buscape-php)[ RSS](/packages/olavocn-buscape-php/feed)WikiDiscussions master Synced 6d ago

READMEChangelogDependenciesVersions (2)Used By (0)

Classe Apiki\_Buscape\_API
==========================

[](#classe-apiki_buscape_api)

Descrição
---------

[](#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 ?
---------------

[](#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 ?
-----------

[](#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é](http://developer.buscape.com/api/)

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

[](#métodos-de-criação-de-código-lomadee)

string Apiki\_Buscape\_API::createSource( array $args )
-------------------------------------------------------

[](#string-apiki_buscape_apicreatesource-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
===============================

[](#métodos-de-consulta-disponíveis)

string Apiki\_Buscape\_API::findCategoryList( array $args )
-----------------------------------------------------------

[](#string-apiki_buscape_apifindcategorylist-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 )
---------------------------------------------------------------------------

[](#string-apiki_buscape_apifindofferlist-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.
- **offerId** Id da oferta.
- **latitude** Coordenada geográfica.
- **longitude** Coordenada geográfica.
- **radius** Coordenada geográfica.
- **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 )
-----------------------------------------------------------------------------

[](#string-apiki_buscape_apifindproductlist-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 )
------------------------------------------------------

[](#string-apiki_buscape_apitopproducts-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 )
-------------------------------------------------------------

[](#string-apiki_buscape_apiviewproductdetails-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 )
------------------------------------------------------------

[](#string-apiki_buscape_apiviewsellerdetails-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 )
----------------------------------------------------------

[](#string-apiki_buscape_apiviewuserratings-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
=====================================

[](#getters-setters-e-métodos-auxiliares)

string Apiki\_Buscape\_API::getApplicationId()
----------------------------------------------

[](#string-apiki_buscape_apigetapplicationid)

Retorna o Id da aplicação.

Veja também Apiki\_Buscape\_API::setApplicationId( string $applicationId )

string Apiki\_Buscape\_API::getCountryCode()
--------------------------------------------

[](#string-apiki_buscape_apigetcountrycode)

Retorna o código do país.

Veja também Apiki\_Buscape\_API::setCountryCode( string $countryCode )

string Apiki\_Buscape\_API::getEnvironment()
--------------------------------------------

[](#string-apiki_buscape_apigetenvironment)

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()
---------------------------------------

[](#string-apiki_buscape_apigetformat)

Retorna o formato de retorno (*xml* ou *json*).

Veja também Apiki\_Buscape\_API::setFormat( string $format )

string Apiki\_Buscape\_API::getSourceId()
-----------------------------------------

[](#string-apiki_buscape_apigetsourceid)

Retorna o Source ID.

Veja também Apiki\_Buscape\_API::setSourceId( string $sourceId )

void Apiki\_Buscape\_API::setApplicationId( string $applicationId )
-------------------------------------------------------------------

[](#void-apiki_buscape_apisetapplicationid-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](http://developer.buscape.com/admin/registration.html)

Veja também Apiki\_Buscape\_API::getApplicationId()

void Apiki\_Buscape\_API::setCountryCode( string $countryCode )
---------------------------------------------------------------

[](#void-apiki_buscape_apisetcountrycode-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 )
-----------------------------------------------------

[](#void-apiki_buscape_apisetformat-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 )
--------------------------------------------

[](#void-apiki_buscape_apisetsandbox-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 )
---------------------------------------------------------

[](#void-apiki_buscape_apisetsourceid-string-sourceid-)

Define o sourceId

- *string* **$sourceId** O sourceId

Veja também Apiki\_Buscape\_API::getSourceId()

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 59.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/aba2e33471d2acbc6352e87218dcdd485fd96d5f5105be3720c9436d9531a02c?d=identicon)[olavocneto](/maintainers/olavocneto)

---

Top Contributors

[![netojoaobatista](https://avatars.githubusercontent.com/u/273586?v=4)](https://github.com/netojoaobatista "netojoaobatista (28 commits)")[![danielantunes](https://avatars.githubusercontent.com/u/642444?v=4)](https://github.com/danielantunes "danielantunes (9 commits)")[![aleborba](https://avatars.githubusercontent.com/u/594742?v=4)](https://github.com/aleborba "aleborba (6 commits)")[![olavocneto](https://avatars.githubusercontent.com/u/568745?v=4)](https://github.com/olavocneto "olavocneto (2 commits)")[![freiredaniel](https://avatars.githubusercontent.com/u/3181453?v=4)](https://github.com/freiredaniel "freiredaniel (1 commits)")[![tankist](https://avatars.githubusercontent.com/u/454477?v=4)](https://github.com/tankist "tankist (1 commits)")

### Embed Badge

![Health badge](/badges/olavocn-buscape-php/health.svg)

```
[![Health](https://phpackages.com/badges/olavocn-buscape-php/health.svg)](https://phpackages.com/packages/olavocn-buscape-php)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)