> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plug4ia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Integrador Local do Plug4ia

> Entenda como o Integrador Local conecta o Plug4ia ao ambiente do cliente para executar consultas do ERP com segurança.

O **Integrador Local** é o componente instalado no ambiente do cliente para permitir que o Plug4ia consulte os dados do ERP.

Ele fica em uma máquina com acesso ao banco de dados do ERP, recebe as solicitações de consulta, executa localmente e devolve apenas o resultado necessário para a resposta no WhatsApp.

## Por que o integrador é necessário

Muitos ERPs ficam em redes internas, servidores locais ou ambientes que não devem ser expostos diretamente na internet. O Integrador Local permite que a consulta aconteça dentro do ambiente do cliente, sem abrir acesso direto ao banco para o Plug4ia.

<Note>
  As credenciais do banco ficam no ambiente do cliente, no arquivo de configuração do integrador. Elas não são cadastradas no Portal Administrativo do Plug4ia.
</Note>

## O que a Software House configura

Para colocar uma empresa em operação, a Software House precisa:

<Steps>
  <Step title="Cadastrar a empresa no portal">
    No Portal Administrativo, cadastre a empresa e vincule ao ERP correto.
  </Step>

  <Step title="Gerar o token da empresa">
    Na aba de integração da empresa, gere o token de acesso do integrador.
  </Step>

  <Step title="Instalar o integrador no cliente">
    Instale o integrador em Windows ou Linux, conforme o servidor disponível no cliente.
  </Step>

  <Step title="Informar os dados de conexão">
    Configure o token da empresa e os dados de acesso ao banco do ERP.
  </Step>

  <Step title="Validar o status">
    Volte ao portal e confira se o integrador aparece como conectado.
  </Step>
</Steps>

## Onde instalar

O integrador deve ser instalado em uma máquina que tenha acesso aos dados do ERP.

<CardGroup cols={2}>
  <Card title="Servidor do ERP" icon="server">
    Opção comum quando o banco do ERP já está disponível no próprio servidor.
  </Card>

  <Card title="Servidor interno" icon="network">
    Opção indicada quando a Software House prefere separar o integrador do servidor principal, mantendo acesso de rede ao banco.
  </Card>
</CardGroup>

## Sistemas operacionais suportados

<CardGroup cols={2}>
  <Card title="Windows" icon="windows">
    Instalação por assistente. O instalador coleta token, tipo de banco, credenciais e registra o integrador como serviço do Windows.
  </Card>

  <Card title="Linux" icon="terminal">
    Instalação por script com Docker Compose. O script cria o diretório, gera o arquivo de configuração e inicia o serviço em container.
  </Card>
</CardGroup>

## Origens de dados suportadas

O integrador pode ser configurado para acessar diferentes origens, conforme o ERP do cliente.

| Origem          | Quando usar                                                      |
| --------------- | ---------------------------------------------------------------- |
| MySQL / MariaDB | ERPs com banco MySQL ou compatível                               |
| PostgreSQL      | ERPs com banco PostgreSQL                                        |
| SQL Server      | ERPs com banco Microsoft SQL Server                              |
| Firebird        | ERPs com banco Firebird, quando disponível no instalador Windows |

<Info>
  No Linux, o instalador atual permite escolher MySQL, SQL Server ou PostgreSQL.
</Info>

## Segurança

| Item                    | Onde fica                                   |
| ----------------------- | ------------------------------------------- |
| Token da empresa        | Configuração local do integrador            |
| Credenciais do banco    | Configuração local do integrador            |
| Dados do ERP            | Permanecem no ambiente do cliente           |
| Resultado das consultas | Enviado ao Plug4ia para responder o usuário |

<Warning>
  O arquivo de configuração contém credenciais sensíveis. Ele deve ficar protegido no servidor do cliente e não deve ser compartilhado em canais inseguros.
</Warning>

## Status no portal

Depois de instalado, o integrador aparece na tela **Empresas** e no **Dashboard**. Use esse status para confirmar se o cliente está pronto para responder consultas pelo WhatsApp.

Se o integrador estiver desconectado, as perguntas que dependem daquela empresa podem não retornar dados.

## Próximos passos

<CardGroup cols={2}>
  <Card title="Instalação" icon="download" href="/integrador/installation">
    Veja como instalar o integrador em Windows e Linux.
  </Card>

  <Card title="Configuração" icon="settings" href="/integrador/configuration">
    Entenda os campos do arquivo de configuração local.
  </Card>
</CardGroup>
