> ## 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.

# Início Rápido: configure o Plug4ia

> Siga o passo a passo para configurar ERPs, empresas, usuários, WhatsApp, integrador local e enviar a primeira consulta pelo Plug4ia.

Este guia mostra o caminho inicial para colocar o **Plug4ia** em funcionamento para uma Software House: cadastrar o ERP, criar a empresa, configurar o integrador local, liberar usuários, conectar o WhatsApp e validar a primeira consulta.

<Info>
  Para concluir este guia, você precisa ter acesso ao **Portal Administrativo do Plug4ia** e ao ambiente onde o ERP do cliente está instalado.
</Info>

<Steps>
  <Step title="Acesse o Portal Administrativo">
    Abra o Portal Administrativo do Plug4ia no navegador e entre com suas credenciais.

    Após o login, você verá o menu principal com as áreas de **Dashboard**, **Usuários**, **ERPs**, **Empresas**, **Tools** e **Configurações**.

    <Tip>
      Use um usuário com perfil administrativo para realizar a configuração inicial.
    </Tip>
  </Step>

  <Step title="Cadastre o ERP">
    O cadastro de ERP representa o sistema que será atendido pela Software House no Plug4ia.

    No menu lateral, acesse **ERPs** e clique em **Novo ERP**. Preencha:

    | Campo                | Descrição                                               |
    | -------------------- | ------------------------------------------------------- |
    | Nome                 | Nome do ERP que será exibido no portal                  |
    | Tipo de banco padrão | Tipo de banco usado como padrão nas empresas vinculadas |
    | ERP ativo            | Define se o ERP estará disponível para uso              |

    Depois de salvar, o ERP ficará disponível para vínculo com empresas e consultas.
  </Step>

  <Step title="Cadastre a empresa do cliente">
    A empresa representa o cliente, filial ou CNPJ que será consultado pelo Plug4ia.

    Acesse **Empresas** e clique em **Nova Empresa**. Na aba **Dados da empresa**, preencha:

    | Campo              | Descrição                                             |
    | ------------------ | ----------------------------------------------------- |
    | Razão social       | Nome jurídico da empresa                              |
    | Nome fantasia      | Nome comercial exibido no portal                      |
    | CNPJ               | CNPJ da empresa                                       |
    | Inscrição estadual | Inscrição estadual, quando aplicável                  |
    | ERP empresa ID     | Identificador da empresa dentro do ERP, se necessário |
    | Empresa ativa      | Define se a empresa poderá ser usada nas consultas    |

    Em seguida, abra a aba **Integração** e selecione o ERP vinculado a essa empresa.
  </Step>

  <Step title="Gere o token do integrador">
    O token permite conectar o integrador local da empresa ao Plug4ia.

    No cadastro da empresa, acesse a aba **Integração** e clique em **Gerar Token**.

    Copie o token gerado e use-o na configuração do integrador local.

    <Warning>
      Guarde o token em local seguro. Se um novo token for gerado, o token anterior deixará de ser usado na integração.
    </Warning>
  </Step>

  <Step title="Instale e configure o integrador local">
    O integrador local deve ser instalado no ambiente do cliente, em um servidor com acesso ao banco de dados ou arquivos usados pelo ERP.

    Durante a configuração, informe:

    | Campo             | Descrição                                    |
    | ----------------- | -------------------------------------------- |
    | Token da empresa  | Token gerado no cadastro da empresa          |
    | Servidor do banco | Endereço onde o banco do ERP está disponível |
    | Porta             | Porta de conexão do banco                    |
    | Usuário           | Usuário com permissão de leitura             |
    | Senha             | Senha do usuário informado                   |
    | Banco de dados    | Nome do banco usado pelo ERP                 |
    | Limite de linhas  | Quantidade máxima de registros por consulta  |
    | Tempo limite      | Tempo máximo para execução de uma consulta   |

    Após iniciar o integrador, volte ao cadastro da empresa e confirme se o status aparece como conectado.

    <Tip>
      Em produção, mantenha o integrador configurado como serviço do sistema operacional para que ele reinicie automaticamente junto com o servidor.
    </Tip>
  </Step>

  <Step title="Configure as consultas disponíveis">
    As consultas disponíveis definem quais perguntas o Plug4ia poderá responder sobre o ERP. Cada consulta precisa ter uma **consulta SQL configurada**, pois é ela que busca os dados no ambiente integrado do cliente.

    Acesse **Tools** e clique em **Nova Tool**. Preencha:

    | Campo        | Descrição                                                           |
    | ------------ | ------------------------------------------------------------------- |
    | ERP          | ERP ao qual a consulta pertence                                     |
    | Nome         | Nome interno da consulta                                            |
    | Descrição    | Explicação do que essa consulta responde                            |
    | Agente       | Área responsável pela consulta, como vendas, produtos ou financeiro |
    | Consulta SQL | Comando SQL que será executado para buscar os dados no ERP          |
    | Status       | Define se a consulta está ativa                                     |

    <Info>
      A descrição ajuda o Plug4ia a entender quando deve usar aquela consulta durante uma conversa no WhatsApp. Já a consulta SQL define quais dados serão retornados.
    </Info>

    <Warning>
      Antes de ativar uma consulta, valide se a SQL retorna apenas as informações esperadas para o cliente.
    </Warning>
  </Step>

  <Step title="Cadastre os usuários">
    Usuários são as pessoas autorizadas a usar o Plug4ia pelo portal ou pelo WhatsApp.

    Acesse **Usuários** e clique em **Novo Usuário**. Preencha:

    | Campo          | Descrição                                      |
    | -------------- | ---------------------------------------------- |
    | Nome           | Nome do usuário                                |
    | E-mail         | E-mail usado para acesso ao portal             |
    | WhatsApp       | Número autorizado para conversar com o Plug4ia |
    | Tipo de acesso | Perfil do usuário                              |
    | Usuário ativo  | Define se o usuário pode acessar o sistema     |

    <Note>
      O número de WhatsApp cadastrado é usado para identificar quem pode enviar mensagens ao Plug4ia.
    </Note>
  </Step>

  <Step title="Defina as empresas permitidas">
    Depois de cadastrar o usuário, defina quais empresas ele poderá consultar.

    Na lista de usuários, abra o menu de ações do usuário e selecione **Definir empresas**.

    Marque as empresas que esse usuário pode acessar e salve as alterações.

    <Tip>
      Um mesmo usuário pode ter acesso a mais de uma empresa, desde que isso faça sentido para a operação do cliente.
    </Tip>
  </Step>

  <Step title="Conecte o WhatsApp da Software House">
    Acesse **Configurações → WhatsApp** e clique em **Conectar WhatsApp**.

    O portal exibirá um QR Code. No celular que será usado como canal de atendimento:

    1. Abra o WhatsApp.
    2. Acesse **Aparelhos conectados**.
    3. Toque em **Conectar um aparelho**.
    4. Escaneie o QR Code exibido no portal.

    Quando a conexão for concluída, o canal aparecerá na lista com o telefone conectado e o status atual.
  </Step>

  <Step title="Envie a primeira consulta">
    Com ERP, empresa, integrador, usuário e WhatsApp configurados, envie uma mensagem para o número conectado ao Plug4ia.

    Exemplo:

    ```text theme={null}
    Quais foram as vendas de hoje?
    ```

    Se o usuário estiver ativo, com WhatsApp cadastrado e acesso à empresa, o Plug4ia interpretará a pergunta, consultará as informações disponíveis e responderá diretamente na conversa.

    <Tip>
      Você também pode testar um agendamento, como: **"Me envie o total de vendas todos os dias às 8h."**
    </Tip>
  </Step>
</Steps>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Portal Administrativo" icon="gauge" href="/admin/overview">
    Conheça as principais áreas de configuração usadas pela Software House.
  </Card>

  <Card title="Empresas" icon="store" href="/admin/companies">
    Veja como cadastrar clientes, vincular ERPs e acompanhar o status do integrador.
  </Card>

  <Card title="Usuários" icon="users" href="/admin/users">
    Configure acessos, permissões por empresa e números autorizados.
  </Card>

  <Card title="Agendamentos" icon="calendar-clock" href="/features/schedules">
    Crie relatórios automáticos para envio recorrente pelo WhatsApp.
  </Card>
</CardGroup>