# HTTP In

### Workspace URL

O conector HTTP In permite definir uma rota para a URL padrão do seu Workspace. Para consultar a URL única do seu Workspace, acesse a aba de Workspaces no Painel da Conta e copie a URL do Workspace que deseja referenciar.<br>

<figure><img src="/files/T9fY2dDpCb5tbIVyos3o" alt=""><figcaption><p>Copiando a URL do seu Workspace</p></figcaption></figure>

{% hint style="info" %}
Com o conector HTTP In, é possível criar rotas no seu Workspace acessíveis a outros sistemas através de métodos HTTP, tanto com autenticação quanto sem. Isso possibilita o desenvolvimento de uma ampla gama de soluções, incluindo APIs e proxies para outros serviços.
{% endhint %}

<figure><img src="/files/h3kI2OlThybLj7qnvxPQ" alt=""><figcaption><p>Estrutura de uma URL de Workspace.</p></figcaption></figure>

{% tabs %}
{% tab title="Parâmetros" %}

<figure><img src="/files/gYKTcHPimOP6gfAQkkyX" alt=""><figcaption><p>Parâmetros de configuração</p></figcaption></figure>

| Campo               | Tipo            | Descrição                                                                                                                                              |
| ------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Descrição           | Campo de texto  | Descrição visual do conector na construção do fluxo.                                                                                                   |
| Route               | Campo de texto  | Rota que será aberta no Workspace Floui para acesso externo. O botão ao lado permite copiar toda a rota construída para a área de transferência.       |
| Método HTTP         | Seletor         | Método HTTP da rota aberta no Workspace Floui.                                                                                                         |
| Use authentication  | Seletor         | Especifica se haverá autenticação ao realizar requisição para o Workspace Floui. Permite selecionar entre Bearer Token, Basic Auth ou Sem autenticação |
| Token               | Campo de texto  | Campo disponível quando selecionada a autenticação Bearer Token. Permite definir o token que será usado autenticação.                                  |
| Username e password | Campos de texto | Campos disponíveis quando selecionada a autenticação Basic Auth. Permite definir o usuário e senha que deverá ser usado para realizar autenticação.    |
| Output Path         | Campo de texto  | Refere-se ao caminho dos dados da requisição para o Workspace no contexto de execução do fluxo                                                         |
| {% endtab %}        |                 |                                                                                                                                                        |

{% tab title="Construção de rota" %}

## Construção da rota

Para definir uma rota de acesso ao Workspace Floui foram disponibilizadas algumas funcionalidades que auxiliam na construção da sua rota, permitindo que sejam parametrizados dados dinâmicos.&#x20;

### Parâmetros

Para definir parâmetros dinâmicos na rota utilize a notação `:param`. Quando for realizado a requisição para o Workspace Floui os dados do parâmetro poderão ser visualizados e acessados dinamicamente no fluxo.&#x20;

No exemplo abaixo, foi definida a rota `/product/:id`, onde o valor de `:id` na requisição enviada ao Workspace é `12`. Esse identificador e seu respectivo valor podem ser acessados e validados no fluxo utilizando a notação Mustache.

Neste caso, o caminho será `{{msg.payload.params.id}}`, onde `params` é o local onde todos os parâmetros da rota estarão armazenados.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcqubkh477O42GyMgftGx57uPyRnzQE-Kouc2ZV9CamPK9j-FTqxI92JRHEtY2HHm45oxYfBfk3bMXMZnRSJDXkoaki7tLNt-GLiWWot0kp1mrpGIQnZz5w5bWDjTxuKoGmVpxr?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Parâmetros em rota</p></figcaption></figure>

### Variáveis

Além dos parâmetros, também é possível usar variáveis locais do fluxo para criar rotas dinâmicas. Para isso, acesse as configurações do fluxo, clique em Variáveis e defina as chaves e valores desejados. Essas variáveis podem ser incorporadas à rota com a notação `{{var nome_da_variável}}`.&#x20;

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfywLU9RVpy9Crv1bB1YmpGjk1yUUUKvyhxE5nd5v_w3kRlLJvYuIvMzk7-si1TGGWi7fahoatCgCVbLBAPEFgh6Dk8eshTcJJD_X1dxLUOaPZo9cyZ1Uvcy8oQ5apkRddxyyu4NA?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Configuração de variáveis do fluxo</p></figcaption></figure>

O preview exibido no conector mostrará automaticamente o valor correspondente à variável, desde que ela tenha sido previamente configurada.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcIskhoqhI0N-MIoGQpKCt5ya7OHkJFDCqxsp9dwzatHrW3AShrfTLVF1Eu3Vkk4Q_yDITtpUNavtvYBP2-p5B8NtWAtaD3Wu9hCypKOI2PLRzJDYFZ7VnJ12lwlM8-oKPz2y92?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Configuração de variável de fluxo em construção de rota</p></figcaption></figure>

É importante destacar que apenas variáveis locais do fluxo podem ser utilizadas na construção de rotas no conector. Variáveis globais definidas no Workspace não são suportadas. Isso garante que a configuração seja restrita ao contexto do fluxo.
{% endtab %}

{% tab title="Payload" %}

## Sucesso&#x20;

Por padrão, o conector retornará um objeto JSON contendo alguns atributos comuns da requisição.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcW0Mi421zT_xgeEXWPl4b9yAwMirIFiqKHJoXy5U6RiEeKZbvFRLSN1M9Q5WAvYdMJpjgz4PtnbAVMyiHk6z5Fh3F5TcyqpVEXmT2Hjbvo1UjjXNLiEZzqkUTy2fvjj5jj_82b1w?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Sucesso ao acessar endpoint</p></figcaption></figure>

#### Descrição

* route: Indica a rota específica do URL solicitado.
* url: Representa o URL abstraído com referência ao workspace.
* baseUrl: É a parte da URL que corresponde à rota definida.
* originalUrl: Refere-se ao URL originalmente solicitado.
* path: É o caminho definido para a rota.
* method: Indica o método HTTP utilizado na solicitação, neste caso, é "GET".
* headers: Contém informações sobre os cabeçalhos da requisição HTTP, como o agente do usuário, tipos de conteúdo aceitos, idioma preferido, entre outros.
* body: Representa o corpo da requisição, que pode conter dados enviados pelo cliente.
* files: Uma lista indicando possíveis arquivos enviados junto com a requisição.
* query: Contém os parâmetros de consulta (query parameters) enviados na requisição.
* params: São os parâmetros da rota, se houver, definidos como parte da URL.
* protocol: Indica o protocolo utilizado, neste caso, HTTP.
* host: É o URL do engine (motor de processamento) onde a requisição foi recebida.
* ip: Representa o endereço IP da máquina local que originou a requisição.

## Uso de conectores HTTP em fluxos

Quando um conector do tipo HTTP In é utilizado em um fluxo, é também esperado o uso de um conector do tipo HTTP Out. Este é responsável por gerenciar a saída da resposta da requisição recebida pelo HTTP In.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcpRj_LwH_NuXOOXoqg24-sr3eeYCxkusxNowAd_z_bJBlNUfpfUfxNwkP5uHH0jstAbQWoGIh6KwPJEhrCpE3rXnql0B903ilNLqc1eH3Oq50RRybpU2znYt-6Bp2oSRsMHMn7TQ?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Fluxo informa o uso de conector HTTP Out para gerenciar saída de requisição</p></figcaption></figure>

### Autenticação

Em casos de erro na autenticação o fluxo não será executado e será informado um erro de autenticação nos registros de execução. Neste caso para a aplicação que tentou realizar a requisição terá um retorno 401 Unauthorized.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXeIJ20xhividTRe4AabMNL6t4PZbN9gLRCS4ZjZMAoEth06y9jafI9EBWrTd0gRpRPX4aUz0oGDtjhS3e7em_2akmKDaTZTR56thaxpxswl5S0KoZd7z9o4ww_Gdg0EG5ikVUPo5g?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Erro em autenticação</p></figcaption></figure>

Em casos de sucesso o fluxo será executado com sucesso. Adicionalmente, os dados da autenticação Bearer e Basic poderão ser visualizados e acessados durante a execução do fluxo através do caminho {{msg.req.headers.authorization}}, disponibilizado uma camada a mais de segurança.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXceNfm7PB4K0CGwYQ3VTpZlhWXWmyxamYxdf-DyPA1KLcGtWomdGKqDoCgN-Xw0Nr1DKUbyMra0EsN_vY5ecZHBCyVsenCajWShgSXXKSsHcKUrjmKJ_cCGXkezjj8RdrjTrF_BFg?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Dados de autenticação</p></figcaption></figure>

## Retornos padrões

<table data-column-title-hidden data-view="cards"><thead><tr><th align="center">Status</th><th>Detalhes</th></tr></thead><tbody><tr><td align="center"><mark style="color:green;">200</mark></td><td>Retorno padrão destinado a requisição de entrada.</td></tr><tr><td align="center"><mark style="color:red;">429</mark></td><td>Indica que o número de execuções foi atingida</td></tr><tr><td align="center"></td><td></td></tr></tbody></table>
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.floui.io/guia/conectores/categorias/triggers/http-in.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
