Introdução
A WebApiAlcance é a API HTTPS que sustenta os sistemas internos da Alcance Contabilidade. É organizada por domínios de negócio, cada um servido por um router FastAPI sob o prefixo /api/v1/, e agrupada por solução - o mesmo recorte dos produtos da plataforma.
Esta página é o ponto de entrada do catálogo: escolha uma solução para ver a introdução dos seus endpoints, os domínios que a compõem e a referência detalhada de cada rota (método, parâmetros, request/response e escopo exigido).
Antes de integrar
Todos os endpoints exigem autenticação Bearer (JWT ou API Key) e respeitam escopos recurso:acao. Comece por Autenticação e Escopos.
Plataforma e acesso
Endpoints transversais de identidade, infraestrutura e administração - compartilhados por todas as soluções.
Auth
Emissão de JWT para operadores humanos (login com usuário e senha).
Infraestrutura
Health-check público do servidor - sem autenticação nem escopo.
Portal do Cliente
Endpoints que servem o portal do cliente da Alcance.
API Keys
Gestão administrativa de chaves de API e seus escopos.
Scopes
Catálogo dos escopos `recurso:acao` disponíveis na WebApi.
Soluções
Cada solução reúne os domínios de negócio do produto correspondente. Abra a introdução para navegar pelos endpoints daquela solução.
Hub
Núcleo da plataforma: clientes, carteiras, automações tributárias, conversores, agendamentos e dashboards.
Atendimento
Lembretes via WhatsApp, obrigações e catálogos, modelos, contatos e departamentos.
Certidão
Certidões negativas (CND, FGTS, SEFAZ) e situação fiscal, com emissão e monitoramento.
Bob Tax Intelligence
Apuração de impostos, regras de presunção, NFS-e importada e saldos acumulados.
Radar
Integração com o Integra Contador (Serpro): Simples Nacional, DCTFWeb, MIT, guias e recibos.
Contábil
Plano de contas, lançamentos contábeis e fiscais, importações bancárias, regras e balancetes.
SN - Analytics
Declarações e analytics do Simples Nacional: receitas, folha, cálculos e faturamento.
NFS-e - Repasse
Repasse de NFS-e a prestadores e médicos: notas, repasses, demonstrativos e integrações.
Padrão de resposta
Toda resposta da WebApi - sucesso ou erro, qualquer domínio - é envelopada no contrato:
{
"status": "success" | "error",
"message": "Mensagem em PT-BR",
"data": { /* payload específico do endpoint */ }
}Detalhes completos do envelope, códigos de erro e exemplos estão em Conceitos.
Versionamento
Todos os endpoints atuais estão sob o prefixo /api/v1/. Mudanças incompatíveis (breaking changes) serão promovidas em /api/v2/ - v1 permanece operacional durante o período de transição anunciado por changelog. Adições compatíveis (novos campos opcionais, novos endpoints) permanecem em v1.