Skip to content

Commit

Permalink
Ajustes no README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@netojoaobatista
netojoaobatista committed Mar 7, 2011
1 parent 7d91483 commit 93ec6c7
Showing 1 changed file with 34 additions and 34 deletions.
68 changes: 34 additions & 34 deletions README.md
View file
Expand Up @@ -25,13 +25,13 @@ Como Usar ?
. Instancie a classe.
. Use sua instância criada para chamar os métodos da classe.

require_once 'Apiki_Buscape_API.php';
require_once 'Apiki_Buscape_API.php';

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

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

Para mais informações acesse o (guia do desenvolvedor BuscaPé)[http://developer.buscape.com/api/]

Expand All @@ -46,9 +46,9 @@ Método faz busca de categorias, permite que você exiba informações relativas

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.
* __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.

Expand All @@ -60,11 +60,11 @@ Método busca uma lista de ofertas.

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.
* __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.

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.

Expand All @@ -74,9 +74,9 @@ string Apiki_Buscape_API::findProductList( array $args )
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.
* __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.
Expand All @@ -87,34 +87,34 @@ 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.
* __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.
* __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.
* __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.
* __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
=====================================
Expand Down Expand Up @@ -159,7 +159,7 @@ void Apiki_Buscape_API::setApplicationId( string $applicationId )

Define o Id da aplicação.

. _string_ __$applicationId__ ID da aplicação registrado no BuscaPé.
* _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]

Expand All @@ -170,14 +170,14 @@ 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
* _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()

Expand All @@ -186,7 +186,7 @@ void Apiki_Buscape_API::setFormat( string $format )

Define o formato de retorno.

. _string_ __$format__ Formato do retorno, pode ser __xml__ ou __json__
* _string_ __$format__ Formato do retorno, pode ser __xml__ ou __json__

Veja também Apiki_Buscape_API::getFormat()

Expand All @@ -202,6 +202,6 @@ void Apiki_Buscape_API::setSourceId( string $sourceId )

Define o sourceId

. _string_ __$sourceId__ O sourceId
* _string_ __$sourceId__ O sourceId

Veja também Apiki_Buscape_API::getSourceId()

0 comments on commit 93ec6c7

Please sign in to comment.