Antes de começar (Checklist)

---

• Utilizar Windows Server 2012 ou superior, preferencialmente em versão ainda suportada pela Microsoft®.
• Instalar e habilitar IIS 7.5 ou superior no servidor.
• Liberar uma porta HTTP no servidor, com padrão 3000 e possibilidade de configuração conforme política do ambiente.
• Garantir acesso de rede TCP entre o servidor da Bimer API e o servidor do Banco de Dados SQL Server.
• Garantir acesso ao banco de dados SQL Server onde está a base do Bimer, incluindo permissão para criação do login utilizado pela Bimer API.
• Ter acesso ao módulo Cadastro de Usuário do Bimer.
• Confirmar compatibilidade entre a versão da Bimer API e a versão do Bimer Desktop.
• Disponibilizar uma base de homologação do Bimer, recomendada para testes antes da implantação em produção.
• Validar as funcionalidades disponíveis na documentação oficial da Bimer API.
• Considerar que a API pode ser consumida por qualquer cliente HTTP e validada em navegadores modernos, como Chrome, Edge e Firefox.

Guia de Configuração e Dependências

---

1. Prepare o ambiente do servidor
   Verifique se o servidor atende aos requisitos mínimos antes de iniciar a instalação: Windows Server 2012 ou superior, IIS 7.5 ou superior habilitado e uma porta HTTP disponível. A porta padrão é 3000, mas ela pode ser alterada conforme a política do ambiente.
   Em seguida, valide a comunicação TCP entre o servidor da Bimer API e o servidor do Banco de Dados SQL Server. Essa conectividade deve permitir autenticação, consultas e demais operações necessárias para o funcionamento da API.
   
   
2. Configure o acesso ao banco de dados e usuários
   Confirme o acesso ao banco de dados SQL Server onde está a base do Bimer. Garanta também as permissões necessárias para criação e uso do login que será utilizado pela Bimer API.
   No Bimer, acesse o módulo Cadastro de Usuário e revise as permissões exigidas para a integração. Corrija divergências antes de prosseguir, pois elas podem impedir autenticação ou limitar funcionalidades da API.
   
   

3. Valide as dependências do ecossistema
   Execute o instalador da Bimer API para que as dependências necessárias sejam configuradas automaticamente, incluindo runtime .NET 8 e módulos do IIS. Não é necessário instalar esses componentes manualmente.
   Depois, confirme se o BimerConnect está disponível e compatível com a versão do Bimer em uso. Esse componente viabiliza a comunicação entre componentes internos e integrações relacionadas.
   
   

4. Consulte a documentação e finalize a validação
   Acesse a documentação oficial da Bimer API para validar endpoints, autenticação, exemplos de uso e recursos disponíveis para integração. Use essa etapa como conferência final antes dos testes ou da implantação.

MCP Embutido (Assistente IA para Integradores)

---

O MCP Embutido é um servidor Model Context Protocol integrado diretamente à Bimer API. Ele disponibiliza a base de conhecimento da API para consulta via IA, apoiando integradores na localização de endpoints, entendimento de contratos, análise de divergências e implementação de fluxos.

Como funciona

• O MCP Server é hospedado dentro do próprio processo da Bimer API.

• Ao iniciar a API no ambiente do cliente, o MCP fica disponível automaticamente por endpoint na mesma porta configurada para a API, por exemplo: http://localhost:3000/bimer-mcp.

• Não requer instalação separada, configuração adicional ou infraestrutura extra.

• Ferramentas compatíveis com o protocolo MCP, como Kiro e Claude Desktop, podem se conectar para consulta.

O que o MCP disponibiliza

• Documentação completa de endpoints, rotas, parâmetros, contratos e exemplos.

• Guias de fluxos de integração, como cadastro de pessoa, geração de título e emissão de boleto.

• Divergências comuns e orientações para resolução.

• Informações de autenticação e autorização.

• Busca inteligente por funcionalidade, endpoint ou divergência.

Benefícios e Restrições

• Benefícios: dúvidas respondidas via IA, redução de chamados de suporte, onboarding mais rápido de integradores, documentação atualizada junto ao código e sem custo adicional de infraestrutura.

• Restrições: não expõe informações técnicas internas, não permite operações de escrita via MCP e não deve impactar a performance da API principal.
  
  

Atualização e Manutenção

---

As atualizações da Bimer API devem ser realizadas preferencialmente pelo UpdateCenter, seguindo o fluxo corporativo de atualização da Alterdata. Antes de atualizar, valide a versão do Bimer, realize backup quando aplicável e execute testes em base de homologação.

Após a atualização, confira a disponibilidade do serviço, a porta configurada, a conectividade com o banco de dados, o endpoint /bimer-mcp e os principais endpoints documentados.

Atalhos e Avisos

---

 Última atualização:  23/07/2026 | Téc. responsável: weberson.dsn.erp | Redator Téc.: mimaciel.uca