---
description: >-
  Esta página contém informações sobre como você pode chamar APIs externas
  dentro dos seus fluxos de conversa (chat flows).
---

# Chamadas de APIs Externas em seus Fluxos de Chat

> **Atualmente, o componente de chat com API está disponível apenas para o Bot do WhatsApp.** Em breve estará disponível para os demais canais.

\
&#x20;\


#### ❓ **O que é uma API Externa?** <a href="#viewer-vbkj21293" id="viewer-vbkj21293"></a>

**Uma API externa (Interface de Programação de Aplicações) é um conjunto de regras e protocolos que permite que um software interaja e se comunique com outro sistema, serviço ou plataforma externa.**

**Ela permite que diferentes programas acessem e troquem dados e funcionalidades de forma integrada, mesmo que tenham sido desenvolvidos por organizações diferentes ou estejam hospedados em servidores distintos.**\


#### 🔧 **Tipos de APIs** <a href="#viewer-3ji421308" id="viewer-3ji421308"></a>

**Existem vários tipos de APIs, cada um com finalidades e casos de uso específicos.**

> Atualmente, damos suporte a APIs RESTful baseadas em JSON, utilizando:

* **API Key (chave de API)**
* **Token JWT**
* **APIs públicas (sem autenticação)**

\
\
\


#### 🔄 F**luxo de Uso das APIs nos ChatFlows** <a href="#viewer-hppn71328" id="viewer-hppn71328"></a>

**A seguir, apresentamos o fluxo básico para utilizar APIs dentro dos seus fluxos de chat:**

\


<figure><img src="https://static.wixstatic.com/media/dfb36c_dfea93c0951940a785db9ebd5a037d6c~mv2.png/v1/fill/w_740,h_493,al_c,q_90,usm_0.66_1.00_0.01,enc_avif,quality_auto/dfb36c_dfea93c0951940a785db9ebd5a037d6c~mv2.png" alt="Fluxo de Trabalho para Usar APIs nos ChatFlows"><figcaption></figcaption></figure>

Fluxo de Trabalho para Usar APIs nos ChatFlows

\


#### **Usando APIs nos Fluxos de Conversa (Chatflows)** <a href="#viewer-i77mc2082" id="viewer-i77mc2082"></a>

**Para integrar APIs de forma eficiente nos seus fluxos de conversa dentro da Etherna IA, siga o passo a passo abaixo:**\


#### ✅ **Passo 1: Acesse o Painel da Etherna IA** <a href="#viewer-7ras92088" id="viewer-7ras92088"></a>

**Faça login na sua conta da** [**Etherna IA**](https://app.ethernaia.com/) **e acesse o dashboard principal.**\


#### ✅ **Passo 2: Vá para a Seção de Desenvolvedores** <a href="#viewer-ay7572095" id="viewer-ay7572095"></a>

**No menu lateral, clique em “Mais”. Dentro da seção "Mais", selecione “Desenvolvedores”.**\


<figure><img src="https://static.wixstatic.com/media/dfb36c_b909c38eafae43e790b27a59db3581e7~mv2.jpg/v1/fill/w_740,h_339,al_c,q_80,usm_0.66_1.00_0.01,enc_avif,quality_auto/dfb36c_b909c38eafae43e790b27a59db3581e7~mv2.jpg" alt=""><figcaption></figcaption></figure>

\


#### ✅ **Passo 3: Prepare os Atributos Personalizados** <a href="#viewer-8ovub2104" id="viewer-8ovub2104"></a>

**Antes de prosseguir, verifique se você já criou os atributos personalizados que serão usados nas interações com a API.Esses atributos ajudarão a capturar e organizar os dados.**

> Consulte a documentação de: [**Gerenciar e Usar Atributos Personalizados**](https://www.ethernaia.com.br/post/gerenciar-e-utilizar-atributos-personalizados)

#### ✅ **Passo 4: Adicione uma Nova API** <a href="#viewer-v15h42117" id="viewer-v15h42117"></a>

**Na seção “Desenvolvedores”, localize “Suas APIs” e clique em “Adicionar API” no canto superior direito.**\


<figure><img src="https://static.wixstatic.com/media/dfb36c_c704a3bc9f134d5a99de8567ca669c7f~mv2.png/v1/fill/w_740,h_256,al_c,q_85,usm_0.66_1.00_0.01,enc_avif,quality_auto/dfb36c_c704a3bc9f134d5a99de8567ca669c7f~mv2.png" alt="Adicionar API"><figcaption></figcaption></figure>

Adicionar API

\


#### ✅ **Passo 5: Configure Sua API** <a href="#viewer-gon5n2128" id="viewer-gon5n2128"></a>

**Em "Configurar APIs", preencha os seguintes campos. A estrutura é semelhante ao Postman:**

* **Nome da API: Nome de exibição para facilitar a identificação.**
* **Método da API: Escolha o método HTTP (ex: GET, POST, PUT).**
* **URL da API: Informe a URL da API que deseja chamar.**
* **Parâmetros de Consulta (Query Parameters): Adicione os parâmetros necessários.**
* **Cabeçalhos (Headers): Inclua os cabeçalhos exigidos pela API.**
*   **Corpo da Requisição (Body): Defina o corpo da requisição, se necessário.**\


    <figure><img src="https://static.wixstatic.com/media/dfb36c_f1cf343c6d114d05967b73363d2e1dab~mv2.png/v1/fill/w_704,h_314,al_c,q_85,usm_0.66_1.00_0.01,enc_avif,quality_auto/dfb36c_f1cf343c6d114d05967b73363d2e1dab~mv2.png" alt="Configurar API"><figcaption></figcaption></figure>

    Configurar API

> **Nota:** Para inserir variáveis personalizadas na URL ou corpo da requisição, utilize **“/”** como marcador. Porém, no primeiro momento, use valores reais para testar a estrutura da resposta da API.

#### ✅ **Passo 6: Teste a API** <a href="#viewer-1qdl62166" id="viewer-1qdl62166"></a>

**Vá até a aba “Gerenciar Resposta da API” e clique em “Testar” usando os valores reais. Isso permitirá que a Etherna IA entenda o formato da resposta da API.**\


#### ✅ **Passo 7: Mapeie a Resposta da API com Atributos Personalizados** <a href="#viewer-ib4ud2177" id="viewer-ib4ud2177"></a>

**Ainda na aba “Gerenciar Resposta da API”, associe os dados retornados pela API aos atributos personalizados da Etherna IA.**\


#### ✅ **Passo 8: Substitua os Valores Reais** <a href="#viewer-oxha32186" id="viewer-oxha32186"></a>

**Depois de mapear, substitua os valores reais pelos atributos personalizados configurados.**\


#### ✅ **Passo 9: Acesse seu Chatflow** <a href="#viewer-utw2o2193" id="viewer-utw2o2193"></a>

**Vá até o fluxo de conversa do seu bot clicando em “Editar seu Chatflow” dentro da seção “Robôs”.**\


<figure><img src="https://static.wixstatic.com/media/dfb36c_6f483e8f29a2492698ae1d5b936fa3c1~mv2.png/v1/fill/w_740,h_294,al_c,q_85,usm_0.66_1.00_0.01,enc_avif,quality_auto/dfb36c_6f483e8f29a2492698ae1d5b936fa3c1~mv2.png" alt="Componente API"><figcaption></figcaption></figure>

Componente API

\


#### ✅ **Passo 10: Selecione o Componente "API"** <a href="#viewer-9o5ly2202" id="viewer-9o5ly2202"></a>

**Na lista de componentes do chat, selecione o componente “API”.**\


#### ✅ **Passo 11: Chame a API** <a href="#viewer-fym822209" id="viewer-fym822209"></a>

**No painel lateral direito, escolha a API que você configurou anteriormente pelo nome.**\


<figure><img src="https://static.wixstatic.com/media/dfb36c_226b691ed5354932a6fbf7243153cb32~mv2.png/v1/fill/w_740,h_336,al_c,q_85,usm_0.66_1.00_0.01,enc_avif,quality_auto/dfb36c_226b691ed5354932a6fbf7243153cb32~mv2.png" alt="Painel"><figcaption></figcaption></figure>

Painel

#### ✅ **Passo 12: Mapeie as Próximas Perguntas** <a href="#viewer-q0ny52214" id="viewer-q0ny52214"></a>

**Defina qual pergunta ou ação será disparada com base no código de resposta da API (ex: 200, 300, etc.).Se o código de resposta não corresponder a nenhum valor definido, será usada a ação padrão vinculada a "outros".**

#### 🎉 **Pronto!** <a href="#viewer-i3zce2225" id="viewer-i3zce2225"></a>

Sua API está conectada e pronta para **melhorar o desempenho do seu chatbot**, criando **interações dinâmicas**
