> For the complete documentation index, see [llms.txt](https://docs.fortics.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fortics.com.br/perguntas-frequentes/perguntas-frequentes-1/chat-center/automacao-com-api-rest-conectando-sistemas.md).
# Automação com API REST: conectando sistemas
A integração via REST permite que o seu fluxo de atendimento "converse" com outras plataformas. Imagine o cliente digitar um CPF e o robô consultar automaticamente uma dívida no seu sistema financeiro ou abrir um chamado em um software de suporte. Isso é possível através deste módulo.
## Por que usar a integração REST?
**Disponibilidade total:** O robô trabalha 24/7 consultando informações sem intervenção humana.
**Velocidade:** Processos como emissão de 2ª via de boleto ou consulta de status de pedido levam segundos.
**Baixo esforço de desenvolvimento:** Você não precisa ser um desenvolvedor sênior para configurar; basta entender a lógica de troca de informações (JSON) e possuir os dados do sistema externo.
## Pré-requisitos
Para integrar o Chat Center a qualquer outro sistema, você precisará obrigatoriamente de quatro informações que devem ser fornecidas pelo desenvolvedor do sistema que você deseja conectar:
1. **URL (End Point):** É o endereço para onde o Chat Center enviará as informações.
2. **Método**: Geralmente **GET** (para buscar dados) ou **POST** (para enviar/gravar dados).
3. **Autenticação**: Como o sistema saberá que o Chat Center tem permissão? (Ex. : Token no Header, Bearer Token, ou API Key).
4. **Body (Corpo da Requisição)**: O formato das informações que serão trocadas, geralmente em **JSON.**
5. **Liberação de IPs**: Muitos servidores, firewalls e sistemas integradores possuem regras rígidas de segurança e bloqueios de acesso internacional por padrão.
{% hint style="warning" %}
**## Importante**
Como a infraestrutura do Chat Center opera em nuvem e o IP utilizado pode vir de instâncias de outros países, a falta de liberação prévia desses endereços impedirá completamente a comunicação e o funcionamento correto da sua integração.\
\
Portanto, antes de testar a conectividade, você deve encaminhar a lista de IPs do Chat Center para a equipe de infraestrutura ou segurança do sistema que está sendo conectado, solicitando a liberação (*whitelisting*) no firewall ou servidor de hospedagem.
\
**IPs para Liberação** Os IPs que normalmente necessitam de liberação na sua infraestrutura para permitir o tráfego do Chat Center são:
* 34.68.159.37
* 35.208.86.112
* 35.208.233.136
* 35.208.108.9
*Nota: Em situações específicas e a depender do caso, a nossa equipe de suporte poderá solicitar a liberação de IPs adicionais.*
{% endhint %}
## Configuração de API Rest: Aplicativos vs. Customizados
Ao iniciar uma nova integração via API Rest, você encontrará duas abas principais. A escolha entre elas depende do nível de automação que você deseja e se o sistema de destino já possui uma integração pré-configurada pela Fortics.
#### 1. Aba: Aplicativos (Integrações Pré-configuradas)
Esta aba funciona como um sistema de **"Macros"**. Ela foi desenhada para agilizar o processo, trazendo as configurações técnicas prontas para você das [APIs listadas no Marketplace](/perguntas-frequentes/perguntas-frequentes-1/chat-center/marketplace-do-chat-center.md).
* **Campos exclusivos**: Você encontrará os campos **Categoria** (para escolher o sistema, como um CRM específico) e **Item** (para escolher qual ação deseja realizar naquele sistema).
* **Vantagem**: Ao selecionar a categoria e o item, o Chat Center preenche automaticamente toda a estrutura base e os dados de conexão da API. Isso elimina o trabalho manual massivo e reduz drasticamente as chances de erro técnico. Você ainda precisará preencher manualmente as informações sensíveis e chaves privadas que não são injetadas de forma automática, tais como **tokens, senhas e outras credenciais de autenticação**.
#### 2. Aba: aplicativos customizados (flexibilidade total)
Esta aba é voltada para desenvolvedores ou casos onde o sistema que você deseja integrar não está listado no Marketplace.
* **Diferencial:** Aqui, os campos "Categoria" e "Item" não existem. Você tem uma tela em branco para configurar livremente *endpoints* (endereços da API), cabeçalhos e métodos de qualquer aplicação externa.
* **Vantagem**: Oferece controle total sobre a integração, permitindo conectar o Chat Center a sistemas proprietários ou ferramentas de nicho que ainda não possuem um modelo pré-criado.
## Criando uma nova integração
Para acessar a área de **Integrações API Rest**, utilize o menu lateral esquerdo e navegue até **Integrações > Rest**, como mostra a imagem abaixo.
### Para uma integração pré-configurada (Aplicativos)
Na tela de REST selecione a aba aplicativos para configurar um aplicativo pré-configurado disponível no Marketplace.
Nesta modalidade, você conta com "macros" de configuração: basta selecionar a **Categoria** (o sistema desejado) e o **Item** (a ação específica). O sistema preencherá automaticamente todos os dados técnicos da API para você.
### Se for usar uma integração customizada (aplicativos customizados)
Na tela de REST, selecione a aba aplicativos customizados para configurar um aplicativo customizado, dando liberdade total para você conectar o seu Chat Center a qualquer API.
Este caminho é ideal se o sistema que você deseja integrar não estiver listado ou se você precisar de uma configuração exclusiva. Aqui, você tem total liberdade para definir endpoints e cabeçalhos manualmente.
## Configurando a API rest
Independentemente da aba escolhida, os próximos passos deste tutorial guiarão você pela configuração de uma API rest.
Ao acessar a aba de Aplicativos ou Aplicativos Customizados, clique no botão “+”, localizado no rodapé ao lado direito da página, para abrir o formulário de cadastro abaixo.
### Aplicativos pré-configurados
Caso esteja criando uma integração com aplicativos pré-configurados (na aba Aplicativos), o seu formulário terá 2 campos extras, onde você pode selecionar a categoria e o item que deseja integrar, e todo o formulário será preenchido com os dados do aplicativo, restando a você apenas completar as informações para atender à sua demanda.
Importante notar que o descritivo dos campos abaixo serve tanto para ambos os casos (aplicativos e aplicativos customizados). Para configurar uma nova conexão, preencha os campos conforme as orientações abaixo:
**Nome:** Insira um título para identificar esta integração. Escolha um nome que facilite a localização quando você for utilizá-la dentro do fluxo de automação (Ex.: "Consulta\_CPF" ou "Integracao\_CRM").
**URL**: É o ***Endpoint*** ou a URL completa para onde a requisição será enviada. Este endereço é fornecido pelo desenvolvedor do sistema ao qual você deseja se conectar.
**Verificar certificados SSL**: Quando ativado, o Chat Center valida se o servidor de destino possui um certificado de segurança (HTTPS) válido e confiável.
**Fixar IP de origem:** Ao marcar esta opção, o Chat Center utilizará um endereço de IP estático e fixo para realizar as requisições.
**Método**: Define o tipo de operação que será realizada no servidor de destino. As opções mais comuns são:
**GET**: É o método mais comum. É utilizado exclusivamente para buscar ou ler informações (ex.: consultar um saldo ou verificar se um CPF existe).
**POST**: Utilizado para **enviar ou criar** novos dados no sistema externo (ex.: cadastrar um novo lead ou enviar um log de atendimento).
**PUT:** Utilizado para **substituir ou atualizar** completamente um registro existente no sistema de destino.
**PATCH**: Semelhante ao PUT, mas utilizado para atualizações parciais (ex.: alterar apenas o status de um pedido sem reenviar todos os dados dele).
**DELETE**: Comando utilizado para **remover ou apagar** uma informação específica no sistema externo.
**Método de Autenticação**: Define como o Chat Center provará ao sistema externo que tem permissão de acesso. Para finalizar a configuração técnica da sua API, você notará que, ao selecionar um Método de Autenticação, a plataforma exibirá campos específicos para cada protocolo (como JWT, OAuth 2 ou P12/PEM). As opções incluem:
**Nenhum**: Escolha esta opção para APIs públicas ou que não exigem validação de identidade para responder.
**JWT (JSON Web Token)**: Um padrão de mercado onde se utiliza um token criptografado para garantir a segurança. É muito comum em integrações com microsserviços modernos.
**OAuth 2:** O protocolo de autorização mais utilizado atualmente (por Google, Microsoft, etc.). Ele permite que o Chat Center acesse recursos do sistema externo através de um fluxo de permissões seguro, geralmente usando *Client ID* e *Client Secret*.
**OAuth + P12/PEM**: Uma variação avançada de autenticação que, além do protocolo OAuth, exige o uso de **Certificados Digitais** (arquivos .P12 ou .PEM). É o padrão exigido por sistemas bancários e órgãos governamentais de alta segurança.
{% hint style="warning" %}
**##Importante**\
É fundamental entender que **o Chat Center não gera essas informações;** ele apenas as utiliza para validar o acesso.
Todos os dados solicitados nos formulários dinâmicos de autenticação (como Client ID, Client Secret, URL Request Token ou arquivos de certificado) **devem ser obtidos diretamente com a plataforma ou sistema que você deseja integrar.**
{% endhint %}
Para que a sua integração seja processada corretamente pelo sistema de destino, o Chat Center permite que você escolha a estrutura de dados nos campos **Parâmetros, Cabeçalhos e Corpo (Body).**
Em cada um desses campos, você verá um seletor para escolher entre duas opções de formato:
### Formatos permitidos (JSON/Formulário)
**Formulário (Form-Data / Key-Value):**
**O que é**: Uma interface simples de "Chave e Valor". Você digita o nome do campo de um lado e o valor do outro. Ao clicar no ícone de **“+”**, você vai adicionando linhas à tabela para poder enviar múltiplos valores.
**Quando usar**: Ideal para parâmetros de URL (Query Strings) simples ou quando a API externa exige o formato application/x-www-form-urlencoded. É a forma mais fácil de mapear variáveis rápidas, como token ou id.
**JSON (JavaScript Object Notation)**:
**O que é**: Uma estrutura de texto organizada em blocos { }, que permite enviar dados mais complexos e hierárquicos.
**Quando usar**: É o padrão de quase todas as APIs modernas. Use sempre que precisar enviar objetos aninhados, listas ou quando o servidor de destino exigir o cabeçalho Content-Type: application/json.
{% hint style="warning" icon="lightbulb-exclamation-on" %}
**##Dica**
Se você estiver em dúvida sobre qual usar, consulte a documentação da API que você está integrando. Se ela indicar que o dado deve ser enviado como payload, o formato mais adequado no Chat Center será o **JSON.**
{% endhint %}
### Descritivo dos campos JSON/Formulário
**Cabeçalhos (Headers)**: Espaço para informações técnicas da requisição, como o Content-Type (ex.: application/json) ou chaves de autorização específicas exigidas pelo sistema externo.
**Parâmetros**: Utilizados para enviar informações complementares, geralmente em requisições do tipo GET (ex.: ?id=123). Você pode usar variáveis como {{customer.phone}} aqui.
**Corpo (Body)**: Campo utilizado principalmente no método **POST.** É aqui que você estrutura os dados que serão enviados ao sistema, geralmente no formato JSON.
Quando todos os campos estiverem preenchidos, clique em **salvar** e você será redirecionado para a lista de API Rest cadastradas com a nova conexão criada.
Com a API Rest criada, agora você pode usar a conexão nos seus fluxos [através do componente RPA.](/perguntas-frequentes/perguntas-frequentes-1/chat-center/componentes-do-fluxo/componente-fluxo-rpa.md)
## Como usar as integrações configuradas na seção REST
É fundamental compreender que todas as parametrizações realizadas na aba **Integrações > REST** funcionam como a base lógica para as automações do seu robô. Após configurar e salvar seu aplicativo nesta seção, ele se torna um recurso disponível para ser acionado [dentro do construtor de fluxo através do componente RPA](/perguntas-frequentes/perguntas-frequentes-1/chat-center/componentes-do-fluxo/componente-fluxo-rpa.md). Ao inserir o componente RPA em sua jornada de atendimento, você deverá selecionar o aplicativo configurado para que o robô execute a consulta ou ação dinâmica em tempo real, utilizando os dados da API para decidir o próximo passo da conversa com o cliente.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## 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, and the optional `goal` query parameter:
```
GET https://docs.fortics.com.br/perguntas-frequentes/perguntas-frequentes-1/chat-center/automacao-com-api-rest-conectando-sistemas.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
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.