Aqui você vai ter de modo prático a forma de como consumir uma API.

Mostraremos para você como podem ser consumidos os serviços dentro dessa ferramenta e daremos orientações para consumir o serviço a partir da ferramenta Postman, que é muito utilizada para testes de API.

Mas, antes de mais nada, é importante você ler a seção "Introdução ao uso de API".

Vamos começar!

Consumindo uma API pelo portal de documentação

Serviço - Listar processos que o usuário pode abrir

1. Abra em uma nova aba do navegador o serviço Listar processos que o usuário pode abrir.

2. Declare a chave de segurança (apikey).

Após obter a "apikey", informe-a em Header na seção "AUTHENTICATION", conforme destacado na imagem abaixo.

3. Declare o identificador do ambiente (X-Server).

Após obter o "X-Server", vá até o parâmetro "X-Server", na seção "Headers" e realize o preenchimento.

4. Declare o endereço (URL) para chamada dos serviços da API.

A URL deve estar declarada para executar o serviço. Clique na informação host na parte indicada como Base URL da imagem abaixo para abrir a configuração e altere a informação de "host" para "api.lecom.com.br".

5. Utilize dos filtros presentes do serviço para restringir o resultado.

Você pode utilizar de um ou mais filtros presentes no serviço para refinar a consulta.

6. Execute a requisição do serviço.

Como esse serviço não necessita de nenhum outro parâmetro obrigatório, utilize o botão "Try it" para a requisição ser executada.

Pronto!

Você pode visualizar o retorno na seção "RESPONSE".

Com esses passos, você já pode consumir qualquer outro serviço. Você também pode observar que é gerado automaticamente um código de REQUEST na seção "CURL". Esta ferramenta permite gerar um código exemplo de REQUEST para várias linguagens, basta selecionar na seção "LANGUAGE".

Dentre as opções, você pode utilizar o "CURL" e importar o código de REQUEST para o aplicativo Postman que informaremos abaixo em "Consumindo uma API pelo Postman".

Consumindo uma API pelo Postman

Você pode utilizar o Postman para consumir qualquer serviço disponibilizado. Para isso, siga os passos abaixo.

Serviço - Listar usuário

1. Abra em uma nova aba do navegador o serviço Listar usuários

2. Declare a chave de segurança (apikey), o identificador de ambiente (X-Server) e o endereço (URL) para chamada dos serviços da API.

Em mãos das informações como a apikey, o X-Server e a URL, declare-os nos respectivos campos do serviço Listar usuários como foi apresentado no exemplo anterior sobre "Consumindo uma API pelo portal de documentação".

3. Utilize dos filtros presentes do serviço para restringir o resultado.

Você pode utilizar de um ou mais filtros presentes no serviço para refinar a consulta. Pegue por exemplo o filtro "name" e informe o nome de um usuário existente.

4. Importe as informações da REQUEST para o Postman.

Os dados informados no serviço Criar usuários são gerados no código de REQUEST na seção "CURL" dentro do portal de documentação e é possível utilizar esse código importando-o na ferramenta Postman. Para importar, deixe selecionado a opção SHELL em "LANGUAGE" e realize a cópia do código de REQUEST.

Abra o aplicativo Postman e realize a importação do CURL copiado.

5. Execute a requisição do serviço pelo Postman.

Após a importação, execute a requisição do serviço pressionando o botão "Send".

Pronto!

A seção "RESPONSE" é aberta automaticamente e você pode visualizar o retorno.