Acesso a APIs abordando o padrão REST

Em um cenário contemporâneo, a habilidade de acessar APIs emerge como um elemento crucial para o sucesso.

Introdução

Neste tutorial vamos conhecer um pouco sobre as requisições de API utilizando o HTTP Request, um poderoso conector que permite configurar chamadas utilizando os métodos GET, POST, PUT ou DELETE.

Requisitos

• Você vai precisar de uma URL para teste dos dados. Neste exemplo usamos o site https://random-data-api.com/documentation

Conectores relacionados

1. HTTP In

2. HTTP Request

3. Condition

4. HTTP Out

5. Debugger

Passo a passo

1. Iniciando o fluxo

O conector HTTP In monitora uma URL defina pelo Workspace e observa sempre que uma requisição de determinado tipo é realizada por um cliente, seja através do navegador ou código.

A rota sempre será composta pela URL do Workspace + o caminho definido através do atributo Route no componente.

Configurando o HTTP in

Saída dos dados

Usando o Debugger podemos observar que a requisição é acompanhada sempre de dois objetos, o req e a carga de payload do componente. Caso o componente estive aguardando algum dado vindo da requisição, você precisaria acessar a carga de payload do componente para manipula-lo.

Podemos observar ainda que a requisição req, padrão do Floui, trás algumas informações como IP, url do host, parâmetros, arquivos, um corpo, cabeçalhos e outros atributos que podem ser usados de acordo com a sua necessidade.

2. Solicitando dados de uma API

Este passo vai depender do desenvolvedor parceiro que ofereceu a API. Por segurança, é essencial seguir as diretrizes e autenticações fornecidas pelo desenvolvedor da API. Certifique-se de utilizar métodos seguros, como HTTPS, e tratar os dados de forma responsável, evitando exposição indevida de informações sensíveis.

Consulte a documentação da API para entender os endpoints disponíveis, os parâmetros necessários e os formatos de resposta esperados.

Voltando ao nosso exemplo, o random data não exige tokens ou cabeçalhos específicos além dos padrões já enviados em todas as requisições, isso torna o nosso exemplo simples e de fácil compreensão.

Configuração do HTTP Request

Saída de dados retornado pela API

Diferente do HTTP In, o HTTP Request retorna três objetos:

• a "carga de payload": renomeado para beers;

• o "response": que contém informações do status e mensagem;

• o "request": que fornece detalhes do tipo de requisição realizada.

Payload do HTTP Request

3. Tratando erros

As etapas de validações são sempre um passo fundamental para prevenir erros não mapeados. Os condicionais são os exemplos mais comuns de como você pode observar atributos de requisições e tomar decisões com base no seu resultado.

Tratar erros é essencial para garantir que seu sistema seja robusto. As validações, muitas vezes implementadas por meio de condicionais, são fundamentais para identificar e lidar com problemas em suas requisições. Certifique-se de considerar uma abordagem abrangente ao validar atributos, para evitar erros não mapeados e promover a estabilidade do sistema.

4. Exportando os dados

Por fim, exportamos os dados da requisição através do HTTP Out, que usa a mesma URL criada no passo 1 através do HTTP In para exibir os dados.

Conclusão

Neste artigo, exploramos a manipulação de requisições de APIs externas por meio do HTTP Request. Além disso, discutimos a criação de links públicos em seu Workspace para monitorar requisições e exportar dados.

Se surgirem dúvidas durante o processo, não hesite em compartilhá-las conosco, utilizando a abertura de chamados disponível em https://floui.freshdesk.com/. Estamos aqui para ajudar a esclarecer qualquer questionamento que possa surgir.