Testando a BimerAPI com o Postman.

Este manual tem como objetivo transformar o processo de teste da BimerAPI em um guia claro e intuitivo, utilizando a ferramenta Postman. Ao final, você conseguirá realizar a autenticação e enviar suas primeiras requisições (como um Pedido de Venda). 

Índice

1. O que Você Precisa Saber

O que é BimerAPI?

A BimerAPI é uma "ponte" ou um meio de integração que permite que sistemas distintos (como um site, aplicativo móvel ou outro software) se comuniquem e troquem dados de forma segura com o sistema Bimer.

O que é Postman?

O Postman é uma ferramenta que funciona como um "emulador" ou simulador do que um sistema faria. Ele permite que você envie requisições HTTP para a BimerAPI e analise o retorno.

Tipos de Requisições (HTTP)

A BimerAPI utiliza métodos de requisição padrão. Conhecer a finalidade de cada um é fundamental:

2. Passo a Passo: Realizando a Autenticação

A Autenticação é a etapa obrigatória para que o sistema prove que tem permissão para se comunicar com a API. O resultado dessa etapa é a geração de um accessToken (token de acesso).

Etapa 1: Preparação no Postman

1. Instale o Postman e abra a aplicação.

2. No Postman, inicie uma nova requisição e selecione o método POST.

3. No campo de URL, digite o endereço da sua API seguido do trecho /auth/token.

   • Exemplo: http://<endereço_de_acesso:porta>/auth/token.

Etapa 2: Configuração de Cabeçalho (Headers)

1. Acesse a aba Headers.

2. Altere a coluna value da variável Content-Type para application/x-www-form-urlencoded.

Etapa 3: Configuração do Corpo (Body)

1. Acesse a aba Body.

2. Mude o tipo de conteúdo de None para x-www-form-urlencoded.

3. Preencha com suas credenciais do Bimer:

Etapa 4: Envio e Coleta do Token

1. Clique no botão Send.

2. O Postman exibirá a resposta na parte inferior.

3. Um código de status 200 OK indica sucesso.

4. No corpo da resposta, localize e copie o conteúdo do campo accessToken.

 
3. Utilizando o accessToken (Exemplo: Criação de Pedido - POST)

Após a autenticação, você precisará do accessToken para provar que está autorizado em cada requisição seguinte.

1. No Postman, inicie uma nova requisição e selecione o método POST.

2. Defina a URL para o serviço desejado.

   • Estrutura: http://<endereço_de_acesso:porta>/<Nome_do_Serviço>/<Recurso>

   • Exemplo de URL de Pedido de Venda: http://<endereço_de_acesso:porta>/vendas/pedidoVenda

3. Acesse a aba Headers da requisição do pedido.

4. Adicione a chave Authorization.

5. No campo Value, insira a palavra bearer seguida de um espaço e o accessToken que você copiou.

   • Exemplo: bearer eyJ[...]2sxUasdpxxijasijxasjxa.

6. Configure o Body da requisição com os dados do Pedido de Venda.

7. Clique em Send.

8. O status 200 na resposta indica que o Pedido de Venda foi criado com sucesso no Bimer.