.NET

23 dez, 2010

Como usar a classe Apiki BuscaPe API para .NET

Publicidade

No artigo de hoje veremos como consumir a classe de wrapper Apiki_BuscaPe_API escrita em .NET.

Para facilitar a vida dos desenvolvedores, o BuscaPé preparou a classe Apiki_BuscaPe_API. A classe foi desenvolvida em duas linguagens, PHP e .NET, a fim de agilizar o desenvolvimento de aplicações utilizando a API do BuscaPé. Funcionando como um wrapper para a API, as classes implementam todas as funcionalidades disponibilizadas pelos services do BuscaPé.

Iniciaremos os trabalhos com a classe de Wrapper para .NET. Para isso, faça o download dos arquivos aqui ou na nossa seção de API.

Criando o projeto

Para começar a utilizar o wrapper da nossa API, vamos criar um novo projeto no Visual Studio acessando o menu File >> New >> Project.

A classe Apiki_BuscaPé_API para .NET foi desenvolvida na linguagem C#, mas isso não impede que você possa consumi-la em um projeto .NET que utilize outra linguagem. Como exemplo, estamos criando um projeto Web também em C#, mas qualquer linguagem que rode sob a plataforma .NET poderá utilizar a classe.

Com o projeto .NET criado, chegou a hora de efetivamente consumirmos a classe Apiki_BuscaPe_API. Poderemos fazê-lo de duas formas diferentes, pois no arquivo que disponibilizamos para download temos a biblioteca (.dll) gerada e o arquivo fonte da API.

Consumindo a biblioteca .dll

Para termos acesso a todos os métodos disponibilizados pelo wrapper em .NET, podemos simplesmente consumir o arquivo .dll com a biblioteca gerada pela sua compilação.

Com o Visual Studio aberto, vá com o botão direito sobre o projeto criado e selecione a opção Add Reference.

Com a tela de Add Reference aberta, selecione a aba Browse e navegue até o local onde foram salvos os arquivos da classe de wrapper. Quando encontrá-los, selecione o arquivo com a extensão dll e clique em ok.

Pronto. O nosso namespace Apiki_Buscape_API agora está disponível para utilização em qualquer arquivo do seu projeto.

Mais à frente, mostraremos como instanciar a classe e os parâmetros necessários para isso.

Utilizando o arquivo fonte .cs

Também disponibilizamos, no pacote para download, o arquivo de código-fonte da classe Apiki_Buscape_API. Dessa forma, vocês poderão utilizar diretamente nos seus projetos esse arquivo. Assim, caso tenham alguma dificuldade com a sua utilização, poderão ver como a classe foi implementada e, se sentirem necessidade de realizar alguma alteração, estarão livres para tal.

Para adicionar o arquivo fonte ao seu projeto, clique sobre ele com o botão direito do mouse e selecione a opção Add >> Existing Item.

Na tela que será aberta, navegue até o local onde foram salvos os arquivos do wrapper, selecione o arquivo com a extensão cs e adicione-o ao projeto.

Pronto. O namespace Apiki_Buscape_API agora está disponível para utilização em qualquer arquivo do projeto.

Instanciando e utilizando a classe Apiki_Buscape_API

Mostramos, até aqui, duas formas de disponibilizar a classe Apiki_Buscape_API para uso em um projeto .NET. Agora vamos efetivamente utilizar a classe em nosso projeto.

Embora possamos consumir a classe de duas formas diferentes, a sua utilização no projeto se dará da mesma forma, independentemente de como a consumimos.

O primeiro passo é adicionar uma referência ao namespace Apiki_Buscape_API em nosso arquivo fonte.

using Apiki_Buscape_API;

Agora a classe já está disponível nesse arquivo para a instanciarmos. No momento em que instanciamos a classe, temos alguns parâmetros para informar. São eles: applicationId, countryCode, format e sandbox.

  • applicationId: O código de uma aplicação do BuscaPé.
  • countryCode: O código do país de origem da aplicação. Serão aceitos os valores: “AR”, “BR”, “CL”, “CO”, “MX”, “PE” e “VE”.
  • format: O formato de retorno dos dados pela API do BuscaPé. Serão aceitos os valores: “xml” e “json”.
  • sandbox: Um valor booleano que define se estaremos utilizando ou não o servidor de testes (sandbox) do BuscaPé.
Apiki_Buscape_API.Apiki_Buscape_API apiBuscape = new Apiki_Buscape_API.Apiki_Buscape_API( '564771466d477a4458664d3d' );

Acompanhem nossos artigos, pois em breve daremos continuidade aos da plataforma .NET, mostrando como utilizar os métodos disponibilizados pelo seu wrapper.

Deixe seu comentário logo abaixo e participe do nosso Fórum de Discussão.