> For the complete documentation index, see [llms.txt](https://help.hyperflow.global/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/integracao/requisicao-rest.md).

# Requisição REST

O módulo **Requisição REST** permite chamar qualquer sistema externo através de uma requisição HTTP, enviando dados e recebendo a resposta diretamente no fluxo. É o módulo mais flexível para integrar o Hyperflow Integrações com sistemas que não têm um módulo específico já pronto.

<figure><img src="/files/SiLV0JvWN5jlxRUw3i0X" alt=""><figcaption><p>Imagem 1 - Visão geral do módulo Requisição REST na área de trabalho do fluxo no Hyperflow Integrações.</p></figcaption></figure>

***

### 🧭 Como acessar

1. No menu lateral, clique em **Gerenciamento de aplicativos**.
2. Em seguida, clique em **Fluxos**.
3. Abra ou crie um fluxo e acesse a área de trabalho do fluxo.
4. No painel de módulos, localize a categoria **Integração** (identificada pela cor azul).
5. Arraste o módulo **Requisição REST** para a área de trabalho do fluxo.

<figure><img src="/files/VNYkIUBW99477CWPobIe" alt=""><figcaption><p>Imagem 2 - Painel de módulos com a categoria Integração expandida e o módulo Requisição HTTP visível.</p></figcaption></figure>

{% hint style="warning" %}
Evite usar diretamente na URL de destino uma variável que vem de algo digitado pelo cliente na conversa, sem validação — isso pode fazer a requisição ser enviada para um endereço não previsto.
{% endhint %}

***

### 🔍 Conhecendo o módulo

Ao clicar duas vezes no módulo na área de trabalho do fluxo, um painel de configuração é aberto na lateral da tela.

<figure><img src="/files/3r5f8vKvhlNFqpwSDH0p" alt=""><figcaption><p>Imagem 3 - Painel de configuração do módulo Requisição HTTP aberto.</p></figcaption></figure>

***

#### 🔗 URL e método

No campo **URL**, informe o endereço do sistema externo que será chamado (aceita variáveis do fluxo). No campo **Método**, escolha entre **GET**, **POST**, **PUT**, **PATCH** ou **DELETE**.

{% hint style="info" %}
Você pode clicar em **Importar cURL** para colar um comando cURL copiado de outra ferramenta e preencher automaticamente a URL, o método, os cabeçalhos e o corpo da requisição.
{% endhint %}

<figure><img src="/files/tXAgRUZt85pSD4882j4W" alt=""><figcaption><p>Imagem 4 - Campos URL e Método preenchidos, com o botão Importar cURL em destaque.</p></figcaption></figure>

***

#### 📋 Cabeçalhos e corpo

* **Cabeçalhos** — informações extras enviadas junto da requisição, em formato JSON (ex.: `{"Authorization": "Bearer {{env.token}}"}`).
* **Corpo** — os dados enviados na requisição, em formato JSON. Só é considerado nos métodos que enviam dados (POST, PUT, PATCH).

<figure><img src="/files/5d1v0Fw8Bo2fSRFFoskh" alt=""><figcaption><p>Imagem 5 - Campos Cabeçalhos e Corpo preenchidos com exemplos.</p></figcaption></figure>

***

#### ⚙️ Opções avançadas

| Campo                       | O que preencher                                                                                                                                                |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tempo limite                | Tempo máximo, em milissegundos, que o módulo espera pela resposta antes de considerar a chamada como falha.                                                    |
| Permitir conexões inseguras | Ignora a verificação do certificado de segurança do site chamado. Use apenas em casos específicos, como testes internos — evite ativar para sistemas públicos. |
| Ativar novas tentativas     | Repete automaticamente a chamada em caso de falha.                                                                                                             |

<figure><img src="/files/9nwNdQI66ALUDT5aTxPb" alt=""><figcaption><p>Imagem 6 - Seção de opções avançadas expandida.</p></figcaption></figure>

***

#### 🔀 Saídas do módulo

O módulo tem duas saídas:

* **Sucesso** — a chamada teve uma resposta de sucesso (código de status HTTP na faixa 200-299).
* **Erro** — qualquer outra situação: erro do sistema chamado (4xx, 5xx), tempo limite esgotado, ou falha de conexão.

<figure><img src="/files/HdwHTrGtGFm3iDovpKqW" alt=""><figcaption><p>Imagem 7 - Módulo na área de trabalho do fluxo mostrando as saídas Sucesso e Erro.</p></figcaption></figure>

***

### 💡 Caso de uso

**Cenário:** uma empresa quer consultar o endereço de um cliente automaticamente a partir do CEP informado na conversa, usando um serviço externo de consulta de CEP.

**Configuração:**

1. Adicione o módulo **Requisição HTTP** ao fluxo.
2. No campo **URL**, informe o endereço do serviço de consulta, incluindo o CEP: `https://exemplo-cep.com/{{input.cep}}`.
3. No campo **Método**, selecione **GET**.
4. Conecte a saída **Sucesso** a um módulo que use o endereço retornado na conversa.
5. Conecte a saída **Erro** a uma mensagem informando que não foi possível localizar o CEP.

**Resultado:** o fluxo consulta automaticamente o endereço a partir do CEP informado, sem necessidade de um módulo específico para esse serviço.

***

### 📌 Dicas úteis

* Use o campo **Cabeçalhos** para enviar tokens de autenticação ou outras informações exigidas pelo sistema externo.
* Sempre conecte a saída **Erro** a algum tratamento, já que chamadas a sistemas externos podem falhar por diversos motivos (indisponibilidade, tempo limite, dados inválidos).
* Ajuste o **Tempo limite** conforme a velocidade esperada de resposta do sistema chamado, evitando que o fluxo fique travado por muito tempo.
* Evite usar diretamente valores digitados pelo cliente na URL de destino sem alguma validação prévia.

***

### 📝 Resumo

* O módulo **Requisição HTTP** chama qualquer sistema externo por HTTP, enviando e recebendo dados no fluxo.
* Os campos principais são **URL**, **Método**, **Cabeçalhos** e **Corpo**.
* É possível importar a configuração a partir de um comando cURL.
* A saída **Sucesso** é ativada para respostas na faixa 200-299; qualquer outra situação segue pela saída **Erro**.