A API Linx ERP é um conjunto de endpoints utilizados para consulta e inserção de dados no ambiente de retaguarda (Linx ERP).

O serviço opera em segundo plano no Windows, realizando a leitura e gravação de dados, conforme requisições realizadas pelo Linx DataConnect e/ou Linx UX.

• Caso o cliente já trabalhe com a versão Self-Hosted/Serviço Windows, não será necessário desinstalar a versão anterior para executar o instalador (.exe) da nova versão, pois o próprio instalador já está preparado para realizar a atualização.
• Caso o cliente ainda possua a versão anterior a 2025 (que roda através do IIS) instalada no servidor, a recomendação é desinstalar/excluir o site IIS para evitar conflito de portas (esta versão IIS já não é mais utilizada por nenhum cliente, com isso não deveria mais estar instalada nos servidores). Em seguida, executar o instalador da versão atual, conforme procedimento descrito abaixo.

1. Execução e Instalação Básica

1. Após efetuar o download, execute o arquivo do instalador.

2. Na Tela de Boas-vindas, clique em Avançar.
   
   
   
   

3. Defina a Pasta de instalação.

4. Selecione a visibilidade da instalação do produto Linx.Erp.Api:

   • Todos (usuários do computador); ou

   • Somente eu.

5. Clique em Avançar e, na sequência, confirme para iniciar o progresso da instalação.
   
   
   
   
   

6. Novamente confirme a instalação clicando em Avançar.
   
   

2. Configuração de Banco de Dados

Após a cópia dos arquivos, a tela de configuração será exibida.

Preencha os dados de conexão com o banco do Linx ERP:

1. Servidor / Usuário / Senha / Banco: Informe as credenciais e o endereço do banco de dados.

2. Timeout: Insira o valor . O timeout é ajustável conforme a necessidade do cliente e deve ser configurado em milissegundos.
3. Porta Serviço: Inserir o número da porta que deverá ser utilizada para este serviço.
4. Encrypt: Define se a comunicação entre a aplicação e o SQL Server será criptografada.
   • True: Criptografa todo o tráfego via TLS/SSL. Recomendado em produção.
   • False: Comunicação não é criptografada.
5. TrustServerCertificate: Especifica se o cliente deve confiar automaticamente no certificado apresentado pelo SQL Server.
   • True: O certificado é aceito sem validação. Indicado somente para ambientes de desenvolvimento ou quando o servidor utiliza certificado self-signed.
   • False: Exige validação completa do certificado. Recomendado em produção.
6. Trusted Connection: Determina o método de autenticação utilizado.
   • True: Usa autenticação integrada do Windows (conta do serviço ou usuário logado).
   • False: Utiliza autenticação SQL, exigindo o preenchimento dos campos Usuário e Senha.
7. Instalar com usuário de serviço: É possível efetuar a instalação utilizando um usuário de serviço, para isso marque a opção "Instalar com usuário de serviço" e preencha o usuário e senha na nova janela que será exibida.
   
   
   
8. Clique no botão Testar conexão para validar a comunicação.
   
   
   
9. Clique em Salvar para registrar as configurações.

3. Conclusão e Validação

1. A mensagem de instalação concluída será exibida. Clique em Fechar.
   
   
   
   

2. Para validar a instalação:

   • Acesse o gerenciador de Serviços do Windows (services.msc).

   • Localize a linha LinxApiErpService.

• Verifique se o serviço está Em Execução/Running.
  
  
  
  
  
• Se necessitar, é possível conferir o local da instalação clicando com o botão direito do mouse no serviço e selecionando a opção Propriedades.
  
  
   
  O "Caminho do executável" corresponde à pasta selecionada no início da instalação.
  
  
  

4. Remover/Reparar a instalação

Uma vez que a API está instalada, ao executar novamente o instalador serão exibidas as opções de Reparar ou Remover a instalação:

Reparar instalação:

1. Caso deseje reparar a instalação ou alterar a configuração, escolha a opção Reparar o produto Linx.Erp.Api.
   
   
   
2. Em seguida, clique em Concluir.
   
   
3. A tela Configurar Instalador será exibida novamente, permitindo alterar as configurações, conforme listadas no passo "2. Configuração de Banco de Dados".
   
   
   
   
4. A mensagem de instalação concluída será exibida. Clique em Fechar.
   
   
   
   

Remover o produto Linx ERP API:

1. Caso deseje reparar a instalação ou alterar a configuração, escolha a opção Remover o produto Linx.Erp.Api.
   
   
   
   
2. Em seguida, clique em Concluir.
   
   
3. A mensagem de produto removido com êxito será exibida. Clique em Fechar.