Seguros API
Overview da Seguros API — vertical de seguros da Simplafy com cotação, jornadas e KPIs sobre NestJS e PostgreSQL.
Seguros API
A Seguros API é o backend da vertical Simplafy Seguros, responsável por sustentar fluxos de cotação, jornadas de propostas e indicadores operacionais do produto. É uma aplicação NestJS publicada em https://api-seguros.simplafy.com.br e mantida no repositório Simplafy-tec/simplafy-seguros.
Esta página é o ponto de entrada da documentação da API. Use os links em Próximos passos para navegar para autenticação, endpoints e guias operacionais.
O que é o Seguros
O Seguros é a vertical de seguros do ecossistema Simplafy. A API expõe os recursos necessários para:
- Gestão de cotações e propostas.
- Acompanhamento de jornadas de atendimento (incluindo a agente Lia no WhatsApp).
- KPIs e indicadores operacionais consumidos pelo frontend de dashboards.
- Integração com o Hub CRM para métricas de assinaturas e pipelines comerciais.
O backend é organizado em módulos NestJS sobre PostgreSQL com TypeORM, autenticação dupla (JWT em cookie httpOnly ou API Key) e auditoria automática nas mutações.
A vertical opera em conjunto com outros produtos Simplafy (Hub, Admin, Saúde). Integrações cross-repo são tratadas via specs específicas por repositório.
Para quem é
Esta API se destina a:
- Times de produto e operações que precisam expor cotações, propostas e relatórios no frontend Seguros.
- Integrações internas com o Hub CRM e com a agente Lia (n8n + WhatsApp via Evolution API).
- Automações e workers que consomem dados de jornadas e indicadores para reconciliação e relatórios.
Não é uma API pública para clientes finais — todo acesso passa por autenticação interna da Simplafy.
Base URL
A API de produção responde em:
https://api-seguros.simplafy.com.brAmbientes adicionais (staging, dev local) e a política de versionamento são detalhados no guia de Autenticação e nas demais páginas desta seção.
Autenticação obrigatória em todos os endpoints. Requests sem credenciais válidas retornam 401. Detalhes em Autenticação.
Stack
A Seguros API é construída sobre as seguintes tecnologias principais:
- Runtime: Node.js 20.x
- Framework: NestJS 10
- Linguagem: TypeScript 5
- Banco de dados: PostgreSQL 16 com TypeORM 0.3
- Autenticação:
@nestjs/jwt+@nestjs/passport(JWT httpOnly cookies, API Key viapassport-headerapikey) - Validação:
class-validatoreclass-transformer - Documentação interna:
@nestjs/swagger - Testes: Jest, Supertest e Playwright
NestJS 10 + TypeORM 0.3 + PostgreSQL 16. Porta padrão local: 3200. Hot-reload via npm run start:dev.
JWT em cookie httpOnly (1h access, 7d refresh) ou API Key. Guard dual (JwtOrApiKeyGuard) tenta JWT primeiro e cai para API Key quando configurado.
Imagens publicadas em ghcr.io/simplafy-tec/simplafy-seguros, rodando no cluster prd-2 no namespace simplafy-prd-hub.
Próximos passos
Autenticação
Como autenticar com JWT em cookie httpOnly ou API Key, fluxo de refresh e tratamento de 401.
Endpoints
Catálogo de rotas disponíveis, contratos de request/response e exemplos de uso.
Ambientes
URLs por ambiente, configuração local e variáveis necessárias para integração.
Repositório
Código-fonte, issues e processos de contribuição da vertical Seguros.