Como instalar e utilizar o Postman para enviar requisições HTTP

O Postman é uma ferramenta para teste de API´s que utilizam o padrão REST, muito útil para realizar testes no Manager SaaSe Manager eDoc, pois é independente de linguagem, podendo testar diversas rotas rapidamente, além de combinações de parâmetros e retornos.

 

Siga o passo a passo descrito abaixo para realizar a instalação da versão Desktop do Postman:

 

Passo 1

 

Faça o download do Postman pelo link: https://www.getpostman.com/downloads/

Escolha a versão de acordo com sua versão do Windows.

 

 

 

 

Após realizar o download execute o instalador do Postman. E a tela inicial irá aparecer como abaixo:

 

 

 

 

Passo 2

 

 

Para utilizar o Postman é recomendado criar uma conta Free, pois todas as suas requisições ficarão salvas na nuvem. Crie a conta e faça login no Postman.

 

A tela de inicio irá surgir como segue abaixo, enumerei a interface do Postman e inseri um pequeno descritivo de cada item:

 

1. Este é o histórico de requisições, tudo que enviar através do Postman ficará gravado aqui, poderá recuperar uma requisição apenas clicando sobre ela.
2. Insira a URL para onde irá disparar a requisição.
3. Este é o botão para enviar.
4. Parâmetros e valores que serão adicionados a URL.
5. Parâmetros e valores que serão adicionados ao Header.
6. Selecione o tipo de requisição que irá enviar.
7. Parâmetros e valores que serão adicionados ao Body.

 

 

 

 

Passo 3

 

 

Agora defina uma URL, o tipo de requisição e entre com os parâmetros/valores. Em nosso sumário HTTP  você encontrá exemplos de requisições GET/POST para serem utilizadas no Manager eDoc e Manager SaaS.

 

 

 

 

Passo 4

 

 

Uma prática muito utilizada para enviar requisições para o Manager eDoc e Manager SaaS é a utilização de Basic Auth para autenticar a comunicação, para isso você deve clicar em Basic Auth, preencher Username e Password e em seguida clicar em "Preview Request".

 

 

 

 

Dessa forma será gerado um hash em seu header no parâmetro Authorization.

 

 

 

 

Pronto! Agora podemos realizar requisições para o Manager eDoc e Manager SaaS.

 

 

Atenção! Dica importante para exportar uma rota para a sua linguagem de desenvolvimento!

 

 

Seguem abaixo dois passos simples:

 

 

Passo 1 

 

 

Para exportar a rota envia, basta selecionar a opção Code no canto superior direito conforme na imagem abaixo:

 

 

 

 

Passo 2

 

 

Em seguida selecione a linguagem desejada para exportar, conforme na imagem abaixo:

 

 

 

 

Finalizado esses passos simples podemos fazer requisições ao Manager SaaS utilizando a linguagem de desenvolvimento!

 

IMPORTANDO COLLECTIONS DAS DOCUMENTAÇÕES OU PASSADAS PELO NOSSO TIME

Nossas documentações possuem algumas collections anexadas ou o nosso time de atendimento pode acaber lhe fornecendo uma. Para importar elas, siga esses passos:

Passo 1 - Collection por json

 

 

Para importar uma collection via json, clique em "Import" e na aba file, clique em "Upload Files". Na caixa que abrir, selecione o json que recebeu referente à collectiont e importe. Confirme o nome. A collection aparecerá na aba "Collections" do lado esquerdo do seu postman.

 

 

 

 

Passo 2 - Collection por link

 

 

Para importar uma collection via link, clique em "Import" e na aba link, cole o link da collection a ser importada. Confirme o nome e a importação. A collection aparecerá na aba "Collections" do lado esquerdo do seu postman.