Como Começar

Agora que você já entende o que o PIER {Labs} e como ele funciona, o próximo passo é obter o acesso ao ambiente Sandbox da API, para começar a desenvolver suas aplicações. Essa etapa é bastante simples e intuitiva, porém o guiaremos nesta tarefa!

Observação: Vale lembrar que não é necessária uma Conta de Usuário para apenas explorar a API!

 

Passo 1 - Criação da Aplicação

Uma vez que você é um usuário cadastrado e fez o login na plataforma, note que a barra superior do site sofre uma mudança: agora é possível observar a aba de "Desenvolvedor". É nela que você vai cadastrar e gerenciar todas suas aplicações que utilizam o PIER {Labs}.

Ao clicar em "Minhas Aplicações", dentro do menu "Desenvolvedor", você será redirecionado para a página de gerenciamento de aplicações do PIER {Labs}.
Ela também pode ser acessada diretamente, através do seguinte link: http://pierlabs.io/api-portal/myapps.
Nela, você tem a opção de acessar detalhes das suas aplicações, caso exista alguma, ou então criar novas.

Para criar uma nova aplicação, basta clicar no botão "Criar Aplicação" ou então navegar até o seguinte link: http://pierlabs.io/api-portal/myapps/new.

Uma vez na página de Criação de Aplicações, basta preencher os dados referentes à aplicação que você deseja desenvolver e clicar no botão "Criar".

Feito isso, você será redirecionado novamente para a tela de Minhas Aplicações, porém sua aplicação aparecerá agora nesta tela.

Sempre que você criar uma nova aplicação, ela irá aparecer na página "Minhas Aplicações".

 

Passo 2 - Códigos de acesso das aplicações

Após a etapa anterior, você já está apto a utilizar a API do PIER {Labs} no desenvolvimento da sua aplicação recém cadastrada. Porém, para que ela funcione corretamente, você precisará ter em mãos dois códigos: o "Client ID" e o "Access Token" da sua aplicação.

O "Client ID" aparece sempre na página "Minhas Aplicações". Note que existem dois códigos na mesma coluna, sendo um o "Client ID" e o segundo o "Client Secret", separados por uma barra. O que você precisa, neste momento, é apenas o primeiro código!

Já para acessar o "Access Token" da aplicação, você precisará clicar em "Detalhes", ao final da linha correspondente à sua aplicação. A página que será mostrada contém o código referente ao "Access Token" daquela aplicação, a aplicação à qual esse token está vinculado e se o "Access Token" está ativo ou não.

Importante! Cada aplicação criada possui seu próprio "Client ID" e um "Access Token" associados a ela. Além disso, a API do PIER {Labs} possui "Access Tokens" diferentes para ambiente de Sandbox e de Produção (a aplicação gerada nesse tutorial funciona apenas como Sandbox, por exemplo). Ou seja, em caso de qualquer erro na aplicação, o primeiro passo a ser testado é se ambos os códigos estão realmente corretos e correspondem ao escopo do ambiente no qual você está desenvolvendo.

 

Passo 3 - Testando a API do PIER {Labs} em Sandbox

Um dos diferenciais do PIER {Labs} é que a API está disponível para conhecimento público no site, com toda sua documentação. Ou seja, não é necessário ser um usuário cadastrado para conhecer o todo o seu potencial. Para acessar essas informações, é disponibilizado um ambiente de testes chamado "API Browser" para interação com a API do PIER {Labs}. Nele, é possível, além de conhecer a documentação da API, que um desenvolvedor com uma aplicação cadastrada possa testar todas as chamadas dos métodos disponíveis na API, porém com uma base de dados genérica (o chamado ambiente Sandbox). Outro grande diferencial é o fato de que a API é exatamente a mesma para Sandbox e Produção! Isso permite que o desenvolvedor teste exaustivamente sua aplicação antes de disponibilizá-la em ambiente de Produção. Note que o "Access Token" de Produção não funcionará no "API Browser"! Para acessar essa funcionalidade, basta navegar no menu da barra superior do site, ir até "Ferramentas" e depois ir em "API Browser".

O "API Browser" pode ser acessado através do seguinte link (deverá aparecer uma página com as versões disponíveis da API, bastando clicar na desejada): http://pierlabs.io/api-portal/swagger.
Após escolher a versão, será apresentada uma tela contendo todos os recursos, ou serviços, disponíveis na API, agrupadas por tópico de interesse.

Cada serviço possui uma breve descrição sobre sua funcionalidade, estrutura, parâmetros e ainda uma lista de mensagens de respostas, para ajudar no desenvolvimento. Ao final de cada um deles, note que existe um botão "Try it out!". Desde que tenha um "Client ID" e um "Access Point" inseridos no início da página, é possível testar cada uma das funcionalidades clicando nesse botão.

Feito isso, algumas informações aparecerão logo abaixo na tela. A primeira delas é a chamada completa "cURL" efetuada pelo API Browser. Note que aparece o endpoint de Sandbox dentro da chamada.

Como a API do PIER {Labs} é baseada em RESTful, para trocar mensagens entre a aplicação e o servidor da Conductor, é necessário utilizar os seguintes métodos HTTP: GET, POST e PUT. Sempre que você precisar recuperar informações, o método GET será utilizado; criar um objeto, o método POST será o escolhido; e atualizar uma entrada, o método PUT será utilizado. Além disso, toda troca de mensagens ocorre por meio de objetos JSON.

Um pouco mais abaixo, temos a resposta do serviço, caso exista, além do código de resposta, indicando se a chamada ocorreu com sucesso (código de resposta 200, por padrão) ou, caso contrário, o código do problema.

Agora é hora de começar suas próprias aplicações!