Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/netojoaobatista/buscape-as

Facilita a integração e agiliza o desenvolvimento das aplicações Actionscript usando a API BuscaPé
https://github.com/netojoaobatista/buscape-as

Last synced: 3 months ago
JSON representation

Facilita a integração e agiliza o desenvolvimento das aplicações Actionscript usando a API BuscaPé

Awesome Lists containing this project

README 

        
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-as



> Faça um clone do repositório



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



> Instancie a classe.

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



	var applicationId :String = '564771466d477a4458664d3d';

	var buscape :BuscapeAPI = new BuscapeAPI( applicationId );

			

	buscape.sandbox().findCategoryList();

	buscape.addEventListener( Event.COMPLETE , function( event :Event ) :void {

		trace( event.target.result );

	} );



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



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

====================================



String BuscapeAPi::createSource( String sourceName , String publisherId , String siteId , Array campaignList , String token )

-----------------------------------------------------------------------------------------------------------------------------



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._



* __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 BuscapeAPi::findCategoryList( uint categoryId , String keyword)

----------------------------------------------------------------------



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.



* __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( uint categoryId , String keyword , uint productId , Boolean lomadee )

-----------------------------------------------------------------------------------------------------



Método busca uma lista de ofertas.

É possível obter a lista de ofertas informando o ID do produto.



* __categoryId__ Id da categoria.

* __keyword__ Palavra-chave buscada entre as categorias.

* __productId__ Id do produto.



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( uint categoryId , String keyword , 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.



* __categoryId__ Id da categoria.

* __keyword__ Palavra-chave buscada entre as categorias.



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

------------------------------------



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:



void BuscapeAPi::viewProductDetails( uint productId )

-----------------------------------------------------



Função retorna os detalhes técnicos de um determinado produto.



* __productId__ Id do produto _(requerido)_.



void BuscapeAPi::viewSellerDetails( uint sellerId )

---------------------------------------------------



Função retorna os detalhes da loja/empresa como: endereços, telefones de contato etc...



* __sellerId__ Id da loja/empresa _(requerido)_.



void BuscapeAPi::viewUserRatings( uint productId )

--------------------------------------------------



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



* __productId__ Id do produto _(requerido)_.



Getters, Setters e Métodos auxiliares

=====================================



String BuscapeAPi::getApplicationId()

-------------------------------------



Retorna o Id da aplicação.



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



CountryCode BuscapeAPi::getCountryCode()

----------------------------------------



Retorna o código do país.



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



String BuscapeAPi::getEnvironment()

-----------------------------------



Retorna o ambiente de integração (_bws_ para produção e _sandbox_ para testes).



Veja também BuscapeAPI::sandbox()



ResultFormat BuscapeAPi::getFormat()

------------------------------------



Retorna o formato de retorno (_xml_ ou _json_).



Veja também BuscapeAPI::setFormat( ResultFormat 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](http://developer.buscape.com/admin/registration.html)



Veja também BuscapeAPI::getApplicationId()



void BuscapeAPI::setCountryCode( CountryCode 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( ResultFormat format )

-------------------------------------------------



Define o formato de retorno.



* _ResultFormat_ __format__ Formato do retorno, pode ser __xml__ ou __json__



Veja também BuscapeAPI::getFormat()



BuscapeAPI BuscapeAPI::sandbox( 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()