Endpoints
A WebApiAlcance é organizada por domínios de negócio, cada um servido por um router FastAPI sob o prefixo /api/v1/. Esta página é o ponto de entrada para o catálogo: lista os domínios com referência detalhada nesta documentação e enumera os demais, que ficam acessíveis diretamente no Swagger.
A documentação detalhada cobre os endpoints que o MCP gateway consome hoje em produção — ou seja, os caminhos efetivamente testados ponta-a-ponta com tráfego real de clientes IA. Os demais domínios são internos ou ainda não foram promovidos ao MCP, mas continuam vivos no servidor e podem ser explorados via Swagger.
Escopo desta v1 da documentação
Apenas 4 domínios têm referência detalhada nesta v1: Customers, Certidão Negativa, Lembretes e Worker Automation — os 4 consumidos hoje pelo MCP. Para os demais, consulte o Swagger ao vivo, que reflete sempre o estado atual da WebApi.
Domínios com referência detalhada
Customers
Clientes PF/PJ — cadastro, dados fiscais, regime tributário, busca por termo e CRUD com escopos restritos.
Certidões Negativas
Emissão e consulta de CND, FGTS e SEFAZ — endpoint binário para PDF e dispatch assíncrono via Celery.
Lembretes
Envio de mensagens transacionais via WhatsApp Business — templates aprovados e idempotência por cliente.
Worker Automation
Consulta de status de tasks Celery (`task_id`) — single source of truth para acompanhar operações longas.
Outros domínios (no Swagger)
Os demais domínios estão registrados em app/api/v1/endpoints/routes.py e seguem o mesmo padrão de autenticação e envelope. Sem referência narrada nesta v1 — use o Swagger para schemas e exemplos.
/auth— emissão de JWT humano (login com usuário/senha). API Keys não passam por aqui./infra— health-check público (/health). Não exige escopo./users— gestão de usuários da plataforma (admin)./grupo-carteira— agrupamentos lógicos de carteiras contábeis./carteira-cliente— associação cliente ↔ carteira do escritório./activities— registro de atividades / log operacional por cliente./activity_errors— erros estruturados de atividades para diagnóstico./user-acessorias— configuração por usuário de obrigações acessórias./acessorias-config— configuração global de obrigações acessórias./declaracao-sn— declarações do Simples Nacional (entrega e status)./report— relatórios consolidados (exportação para Excel/CSV)./automation— automações tributárias gerais./automation/acessorias— automações específicas de obrigações acessórias./conversor-extract— conversor de extratos bancários (entrada)./conversor-report— conversor de relatórios bancários (saída)./dominio-web— importação de arquivos.TXTpara o Domínio Web (Thomson Reuters)./integra-contador/sn— Integra Contador: Simples Nacional (Serpro)./integra-contador/dctf— Integra Contador: DCTFWeb (Serpro)./integra-contador/mit— Integra Contador: MIT (Serpro)./integra-contador/radar/guias— radar DCTFWeb: emissão de guias./integra-contador/radar/recibos— radar DCTFWeb: consulta de recibos./integra-contador/radar/pagamentos— radar DCTFWeb: confirmação de pagamentos./config-envio— configuração de canais de envio (e-mail, WhatsApp)./agendamento-automation— agendamento de execução de automações./situacao-fiscal— emissão e consulta de situação fiscal consolidada./situacao-fiscal-detalhamento— detalhamento item-a-item da situação fiscal./relatorio-iss-data— relatórios ISS por município/competência./customer-qsa— Quadro de Sócios e Administradores por cliente./nfe-salvador-medicos— emissão NF-e específica Salvador (categoria médicos)./customer-account-ns— contas contábeis do cliente no NS Sistemas./api-keys— gestão de API Keys (admin) — nunca expor ao MCP./scopes— catálogo de escoposrecurso:acaodisponíveis./adiantamento-fornecedor— controle de adiantamentos a fornecedores./compras-estoque— compras vinculadas ao estoque./movimentacao-bancaria— lançamentos bancários do cliente./juros-descontos-compromisso— juros e descontos sob compromisso financeiro./movimentacao-estoque— entradas e saídas de estoque./caixa-cartao— movimentações de caixa via cartão./caixa-especie— movimentações de caixa em espécie.
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.