Primeiros passos
Escolha um produto para começar. A plataforma Alcance tem três pontos naturais de entrada — dependendo do seu perfil, um vai fazer mais sentido que os outros.
Nunca use tokens em ambiente público
Bearer tokens (MCP) e API Keys (WebApi) são credenciais sensíveis. Nunca cole em chats públicos, prints, repositórios ou ferramentas de IA fora do controle do time. Se houver suspeita de vazamento, contate o TI imediatamente para revogação.
Caminho A — Integrar IA via MCP
Use este caminho se você quer conectar Claude Desktop, Cursor, Lovable ou ChatGPT à plataforma Alcance, permitindo que o LLM consulte clientes, certidões e lembretes em PT-BR, com PII mascarada por padrão.
- Leia a introdução para ter o panorama.
- Revise os conceitos básicos (Bearer, escopos, PII, dry-run).
- Instale o cliente IA escolhido — siga o guia em MCP — Instalação.
- Teste com os exemplos prontos.
Ir para a documentação do MCP
Visão geral do gateway, tools disponíveis e guias de instalação por cliente.
Caminho B — Consumir a WebApi diretamente
Use este caminho se você é integrador parceiro ou está construindo uma aplicação interna que conversa com a WebApiAlcance sem passar por LLM.
- Solicite uma API Key escopada (
recurso:acao) ao time de TI. - Estude a autenticação Bearer e os escopos disponíveis.
- Consulte a referência de endpoints para começar a consumir.
Ir para a documentação da WebApi
Autenticação, escopos e referência completa dos endpoints da FastAPI on-premise.
Caminho C — Entender a arquitetura
Use este caminho se você está avaliando a plataforma, fazendo onboarding no time interno ou precisa de uma visão arquitetural antes de integrar.
- Arquitetura — diagramas C4, boundaries e padrões inegociáveis.
- Conceitos fundamentais — modelo mental compartilhado pelos dois produtos.
Pré-requisitos comuns
Antes de qualquer integração, você vai precisar de:
- Contato com o TI da Alcance — ti@alcancecontabilidade.com.br para solicitar credenciais e validar o caso de uso.
- Bearer token (MCP) ou API Key (WebApi) fornecido pelo time — emitido com escopo restrito ao que sua integração realmente precisa.
- Ambiente confiável para armazenar a credencial — gerenciador de segredos, variáveis de ambiente do cliente IA ou cofre corporativo.