Primeiros passos com requisição POSTMAN

fabricio.silva · Dezembro 16, 2022

Olá Dev, você sabia?

O Postman permite que você crie e envie solicitações de API.

Envie uma solicitação para um ponto de extremidade, recupere dados de uma fonte de dados ou teste a funcionalidade de uma API. Você não precisa inserir comandos em um terminal ou escrever qualquer código. Crie uma solicitação e selecione Enviar, e a resposta da API aparecerá dentro do Postman.

As APIs fornecem uma maneira estruturada para um aplicativo acessar os recursos de outro aplicativo. Normalmente, essa comunicação acontece pela Internet por meio de um servidor de API. Um aplicativo cliente (como um aplicativo móvel) envia uma solicitação ao servidor e, após o processamento da solicitação, o servidor retorna uma resposta ao cliente.

Uma solicitação inclui a URL do ponto de extremidade da API e um método de solicitação HTTP. O método indica a ação que você deseja que a API execute. Aqui estão alguns dos métodos mais comuns:

GET - recupera dados de uma API.

POST - envia novos dados para uma API.

PATCH - Atualiza os dados parcialmente.

PUT - Atualiza os dados completo de um documento.

DELETE - remove os dados existentes.

Para baixar o postman acesse o link. Comece gratuitamente.

Abaixo demonstrarei como criar um espaço de trabalho, coleção e uma requisição GET.

No gif abaixo temos um exemplo de criação de um workspaces (espaços de trabalho), após abrir o Postman vá à opção “WORKSPACES”, em seguida em “Create Workspace”. De um nome e determine quem poderá acessá-lo, é possível selecionar uma das opções: pessoal, equipe, e pública.

Para mais informações acesse o link Plataforma da API Postman Espaços de trabalho.

Com o espaço de trabalho criado, selecione o mesmo em “workspaces”, e crie sua primeira coleção, para isso clique em NEW, em seguida em COLLECTION, depois clique nos três pontos à frente da coleção criada e renomeie. Gif de exemplo abaixo.

Por último criaremos a requisição, para isso clique nos três pontinhos a frente da coleção criada, em seguida em “add request” ou adicionar solicitação. Por padrão vem com o método GET, podendo ser alterado para outro de sua preferência, exemplo abaixo:

No método GET, esse do exemplo acima, todos os parâmetros são informados na URL da sua solicitação, no gif abaixo vou demonstrar uma solicitação usando esse método, um ponto importante a se destacar e a autenticação, nesse exemplo que vou mostrar abaixo utilizarei a rota consulta de NFe de um de nossos produtos ManagerSaaS e para realizar essa comunicação entre postman e nossa API, é obrigatória essa autenticação com usuário e senha do grupo que desejo acessar. Com o Postman essa autenticação é bem simples, na opção “Authorization” escolha o tipo de autenticação que deseja realizar, nessa solicitação vou utilizar “Basic Auth”, com os parâmetros informados e autenticação será feita, após só clicar em SEND (enviar), o retorno é possível visualizar logo abaixo, caso deseje salvar clique em “save response”(salvar resposta), depois em “save to a file”(salvar em um arquivo).