Guia do usuário
HelpdeskSobre o Floui
  • Conhecendo o Floui
    • Conceito
    • Introdução ao fluxo
    • Glossário
  • Conectores
    • Estrutura do conector
    • Categorias
      • Triggers
        • ⚡Manual Trigger
        • ⚡Flow Trigger
        • ⚡CRON
        • ⚡HTTP In
        • ⚡Form
        • ⚡Subscriber (Pub/Sub)
        • ⚡Queue Consumer V2
        • ⚡Quando um cartão for movido
      • Conectores essenciais
        • Function Javascript
        • Switch
        • Loop / ForEach
        • Condition
        • REST API
        • HTTP Request
        • HTTP Out
        • Range
        • Random
        • Delay
        • Junção
        • Template
        • Comentário
        • Regex
        • Máscara
      • Manipulação de dados
        • In Memory Storage
        • Lista
        • Message Change
        • Transformar valores
        • Transformar valores
        • CSV
        • Ler XLS/XLSX
        • Criar QRcode
        • XML
        • ZIP File
        • Base64
        • MD5
        • Criptografar mensagem PGP
        • Descriptografar mensagem PGP
        • Template
        • JSON
        • JSONata Expression
        • JSONPath Expression
        • JSON Schema validation
        • Oracle
          • Oracle DB Query
        • SQLite 3
          • SQLite3 Exec
          • SQLite3 Query
        • MySQL
          • MySQL Query
        • Data e hora
          • Somar ou Subtrair
          • Criar ou Formatar
          • Comparar valores
      • Manipulação de arquivos
        • File Writer
        • File List
        • File Reader
        • File Remove
        • Externos
          • Upload para FTP
          • Download de FTP
          • Listar arquivos no FTP
          • Remove via FTP
          • SSH Command
          • SCP Download
      • Filas e eventos
        • Subflow Call
        • Subflow Input
        • Subflow Output
        • Publisher (Pub/Sub)
        • Queue Publisher V2
        • Flow Call
        • Flow Output
      • Monitoramento
        • Logger
        • Debugger
      • Serviços do Floui
        • Floui Forms
          • Form Result
        • Floui Database
          • Criar registro
          • Listar registros
          • Consultar por ID
          • Remover registro
          • Atualizar registro
          • Limpar tabela
          • Consultar por campo
          • Salvar registro
        • Floui Datasource
          • Consultar dados
      • Serviços externos
        • Adobe Commerce
          • Empresa
            • Criar empresa
            • Consultar empresa
            • Atualizar empresa
            • Listar empresas
          • Cliente
            • Criar cliente
            • Consultar cliente
            • Atualizar cliente
            • Listar clientes
            • Remover cliente
          • Pedido
            • ⚡Pedido criado
            • ⚡Pedido atualizado
            • Consultar pedido
            • Listar pedidos
          • Cancelamento
            • Cancelar pedido
          • Envio
            • Criar envio para pedido
            • Consultar envio
            • Listar envios
          • Fatura
            • Consultar fatura
            • Listar faturas
            • Criar fatura para pedido
          • Estorno
            • Criar estorno para pedido
          • Produto
            • Criar produto
            • Listar produtos
            • Consultar produto
            • Atualizar produto
            • Associar produto filho
            • Desassociar produto filho
            • Inserir mídia no produto
            • Criar preço especial (Commerce)
            • Remover preço especial (Commerce)
            • Consultar preços especiais (Commerce)
            • Atualizar preço de custo (Commerce)
            • Atualizar preço de custo em lote (Commerce)
            • Remover preço de custo (Commerce)
            • Consultar preços de custo (Commerce)
            • Atualizar tabela de preço do produto (Tier prices)
          • Estoque
            • Consultar item de estoque (MSI)
            • Lista itens de estoque (MSI)
            • Atualiza um item de estoque (MSI)
            • Atualiza lote de itens de estoque (MSI)
          • Carrinho
            • Consultar carrinhos de compras
            • ⚡Item adicionado ao carrinho
          • Exibir mensagem de sessão
        • AWS S3
          • Listar arquivos
          • Ler arquivos
          • Upload de arquivo para AWS S3
          • Remover arquivos
        • Bling ERP (Bling API V3)
          • Pedido de venda
            • Atualizar status de pedido de venda
            • Consultar um pedido de venda
            • Listar pedidos de venda
            • Criar pedido de venda
          • Pedido de compra
            • Listar pedidos de compra
            • Consultar um pedido de compra
          • Produtos
            • Consultar produto
            • Listar produtos
          • Contatos
            • Criar contato
            • Atualizar contato
            • Consultar contato
            • Listar contatos
          • Módulos
            • Listar situações do módulo
            • Listar módulos
          • Notas fiscais
            • Consulta Nota Fiscal
            • Listar Notas Fiscais
        • Google
          • Google Forms
            • Ler respostas do formulário
            • Ler resposta específica
          • Google Sheets
            • Ler planilha
            • Escrever na planilha
            • Adicionar ao final da planilha
          • Google Analytics (GA4)
            • Gerar relatório
        • Groq
          • Transcrição de áudio
          • Chat Completion
        • Linx Microvix B2C
          • Produto
            • Consultar produto
            • Consultar custos de produto
            • Listar custos de produtos
            • Listar detalhes de produtos
            • Consultar detalhes do produto
            • Listar produtos
              • Listar grade 1
              • Listar grade 2
            • Listar marcas
            • Listar linhas
            • Listar setores
            • Listar marcas
            • Listar classificações
          • Cliente
            • Inserir cliente
            • Listar clientes
          • Pedido
            • Inserir pedido
            • Listar pedidos
            • Listar notas fiscais de um pedido
            • Cancelar pedido
            • Atualizar status do pedido
            • Inserir item do pedido
          • Endereço
            • Listar endereços de entrega
            • Inserir endereço de entrega
        • OpenAI
          • Transcrição de áudio
          • Chat Completion
          • Gerador de imagem
        • Passbolt
          • Consultar segredos de um recurso
          • Listar recursos
        • Sankhya
          • Parceiro
            • Consultar parceiros
          • Pedido
            • Inserir pedido
            • Consultar pedidos
          • Produto
            • Consultar produtos
            • Consultar detalhes do produto
            • Consultar estoque
          • Cliente
            • Inserir cliente
            • Consultar clientes
            • Consultar alterações
          • Endereço
            • Inserir endereço
            • Inserir bairro
            • Inserir cidade
            • Inserir região
            • Consultar endereços
            • Consultar bairros
            • Consultar cidades
            • Consultar regiões
        • Slack Notification
        • SMTP
          • Enviar e-mail com SMTP
        • Trello
          • ⚡Quando cartão for movido
          • Listar cartões
          • Criar novo cartão
          • Consultar cartão
          • Buscar por cartões
          • Atualizar campo customizado
          • Mover cartão
          • Adicionar comentário
          • Arquivar cartão
          • Desarquivar cartão
          • Remover cartão
        • Twilio
          • Enviar mensagem Whatsapp
          • Enviar SMS
        • ViaCEP
          • Consulta CEP com ViaCEP
        • Wake Commerce
          • Tabela de preço
            • Inserir uma lista de produtos na tabela de preço
            • Atualizar um produto na tabela de preço
            • Remover um produto da tabela de preço
          • Produto
            • Criar produto
            • Atualizar produto
            • Consulta produto
            • Listar produtos
            • Listar produtos relacionados
            • Atualizar preço do produto
            • Vincular categorias em um produto
            • Adicionar imagens ao produto
            • Adicionar uma nova informação ao produto
            • Atualizar uma informação do produto
          • Pedido
            • Consulta pedido
            • Listar pedidos não integrados
            • Inserir rastreamento e status do pedido
            • Atualizar rastreamento completo
            • Atualizar pedido como completo
            • Atualiza a situação do status do pedido
            • Consulta rastreamento e nota fiscal do pedido
            • Remover vinculo produto/categoria
          • Categoria
            • Criar categoria
            • Consulta categoria
            • Remover vinculo categoria/produto
          • Estoque
            • Atualizar estoque
          • Fabricante
            • Consultar fabricante
            • Criar fabricante
          • Usuário
            • Consultar usuário
            • Vincular usuário ao parceiro
            • Remover o vinculo entre o usuário e o parceiro
            • Buscar a lista de vínculos entre usuário e parceiro
            • Listar usuários
            • Criar usuário
            • Atualizar um usuário pelo e-mail
            • Listar endereços do usuário
            • Atualizar endereço do usuário pelo email
        • Wake Experience
          • Gerar token
          • Inserir pessoas em massa (csv)
  • Ferramentas
    • Construção
      • Versionamento de fluxos
      • Floui Datasources
      • Floui Forms
      • Floui Filas Internas
      • Floui Conectores Personalizados
    • Armazenamento
      • Floui Database
      • Floui Storage
    • Monitoramento
      • Floui Dashboards
      • Execução em tempo real
      • Histórico de execuções
      • Logs de monitoramento
      • Regras de alerta
  • Configurações
    • Variáveis globais
    • Contas de serviço
      • Autorizar conta Bling ERP
    • Grupos
  • Painel da conta
    • Logs de auditoria
  • Funcionalidades
    • Mustache
  • Artigos
    • Criando usuários no Floui
    • Bibliotecas disponíveis
    • Templates
    • Tutoriais
      • Criando seu primeiro Flow
      • Leitura de arquivo CSV
      • Disparos de e-mail após um novo registro no formulário
      • Acesso a APIs abordando o padrão REST
Powered by GitBook
On this page
  • Introdução
  • Requisitos
  • Conectores relacionados
  • Passo a passo
  • 1. Iniciando o fluxo
  • 2. Solicitando dados de uma API
  • 3. Tratando erros
  • 4. Exportando os dados
  • Conclusão

Was this helpful?

  1. Artigos
  2. Tutoriais

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.

PreviousDisparos de e-mail após um novo registro no formulário

Last updated 1 year ago

Was this helpful?

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

Conectores relacionados

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.

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.

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.

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.

Você vai precisar de uma URL para teste dos dados. Neste exemplo usamos o site

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

https://random-data-api.com/documentation
HTTP In
HTTP Request
Condition
HTTP Out
Debugger
https://floui.freshdesk.com/
Configurando o HTTP in
Saída dos dados
Configuração do HTTP Request
Saída de dados retornado pela API
Payload do HTTP Request