simpla.fydocs
Seguros API

seguros-api reference

Auto-generated OpenAPI reference for seguros-api.

User login

Authenticate user and return JWT tokens in httpOnly cookies

User logout

Revoke refresh token and clear authentication cookies

Refresh access token

Generate new access token using refresh token from cookie

Request password reset

Send password reset email to user. Returns success even if email does not exist (security).

Reset user password

Reset user password using token from email. Token is valid for 1 hour and can only be used once.

Api Keys Controller_create

Buscar apólices

Busca apólices por CPF e outros filtros opcionais

Person Controller_create Person With Vehicle

Listar todos os vendedores

Retorna uma lista de todos os vendedores cadastrados. Pode filtrar por status (active/inactive).

Criar novo vendedor

Cria um novo vendedor no sistema

Download do template CSV para importação

Retorna um arquivo CSV template com headers obrigatórios e 2 linhas de exemplo

Buscar vendedor por ID

Retorna um vendedor específico pelo seu ID

Deletar vendedor

Remove um vendedor do sistema

Atualizar vendedor

Atualiza completamente os dados de um vendedor

Alternar status ativo do vendedor

Alterna o status ativo/inativo do vendedor (true/false)

Importação em massa de vendedores

Importa múltiplos vendedores de uma vez. Executa importação parcial: linhas com erro são ignoradas, demais continuam.

Executar job de sincronização de dados

Executa o job para buscar e popular o banco de dados com informações de um período específico

Executar operação via AI Agent

Executa uma operação validada (SELECT/INSERT/UPDATE/DELETE) em uma entidade específica

List user sessions with pagination, filtering, and search

Create new chat session

List user sessions with pagination, filtering, and search

Create new chat session

Get paginated conversations (optimized for infinite scroll)

Get paginated conversations (optimized for infinite scroll)

Get session details

Delete session (soft delete)

Update session

Get session details

Delete session (soft delete)

Update session

Export session with messages as text file

Export session with messages as text file

Add message to session

Add message to session

Get session message history

Get session message history

Prompt Controller_get Default Prompt

Prompt Controller_get All Prompts

Prompt Controller_create Prompt

Prompt Controller_get Prompt By Name

Prompt Controller_update Prompt

Prompt Controller_archive Prompt

Prompt Controller_set Default Prompt

Criar registro de audit log

Cria um novo registro de auditoria para operações do agente IA

Listar conversas do agente IA

Retorna lista paginada de conversas agrupadas por sessão com agregações e filtros. Requer permissão VIEW_AUDIT_LOGS (apenas admin e manager).

Obter detalhes de uma conversa

Retorna todos os logs de auditoria para uma sessão específica, ordenados por timestamp

Obter métricas agregadas do agente IA

Retorna métricas de uso do agente IA incluindo KPIs, evolução temporal, operações e usuários mais ativos. Requer permissão VIEW_AUDIT_LOGS (apenas admin e manager).

Exportar logs de auditoria

Exporta logs de auditoria em múltiplos formatos (CSV, XLSX, JSON, PDF) com filtros e rate limiting (10 exportações/hora). Story 4.5 - AC1-10

Verificar se operação pode ser revertida

Story 4.3 - AC1: Valida se uma operação CRUD pode ser revertida (24h limit, tipo de operação, status, massa). Requer permissão VIEW_AUDIT_LOGS.

Reverter operação CRUD

Story 4.3 - AC2-5: Reverte uma operação CRUD (INSERT→DELETE, UPDATE→restore, DELETE→re-INSERT). Cria audit log da reversão. Requer permissão VIEW_AUDIT_LOGS (admin only).

Listar relatórios salvos

Lista todos os relatórios do usuário (privados) + públicos

Criar relatório salvo

Salva um relatório customizado com nome, queryParams e componentConfig

Obter relatório salvo

Retorna relatório com queryParams e componentConfig (para re-execução)

Atualizar relatório

Atualiza nome ou status público do relatório (apenas owner)

Deletar relatório

Remove relatório salvo (apenas owner)

Get dashboard statistics summary

Returns aggregated KPIs including sales totals, vendor counts, and webhook status

Get sales grouped by day

Returns daily sales count for timeline chart

Get top vendors by sales count

Returns top 10 vendors ranked by number of sales

Get sales distribution by store

Returns sales count grouped by store

Listar alertas de segurança

Retorna lista de alertas com filtros opcionais (status, severidade, usuário)

Contar alertas não resolvidos

Retorna quantidade de alertas com status NEW (para badge no menu)

Obter detalhes de alerta específico

Retorna informações completas de um alerta por ID

Marcar alerta como resolvido

Atualiza status do alerta para RESOLVED e registra quem resolveu

Adicionar nota ao alerta

Atualiza o campo de notas do alerta

Executar detecção manual de anomalias

Endpoint para testes e debug - executa detecção imediata (apenas dev/staging)

Sales Controller_get Sales

Sales Controller_get Vendors

Sales Controller_get Stores

Sales Controller_create Manual Sale

Sales Controller_trigger Webhook

Get sale by ID (API Key)

Sales Controller_delete Sale

Update sale status by event

Events: webhook_received, template_sent, contact_failed, lead_forwarded

Create SDR interaction linked to sale

Vehicles Controller_check Chassi Uniqueness

Listar filtros salvos do usuário

Retorna todos os filtros salvos do usuário, com filtro opcional por página

Criar filtro salvo

Salva uma combinação de filtros com nome e opção de tornar padrão

Editar nome do filtro

Atualiza o nome de um filtro salvo (apenas o owner pode editar)

Deletar filtro salvo

Remove um filtro salvo (apenas o owner pode deletar)

Tornar filtro padrão

Define um filtro como padrão (aplicado automaticamente ao abrir página). Remove is_default de outros filtros da mesma página.

List available Evolution API instances

Returns list of configured WhatsApp instances with labels

List SDR agent sessions from Evolution API

Returns paginated list of WhatsApp chats from Evolution API instances with phone number extraction and last message details

List messages for a chat

Returns paginated list of WhatsApp messages from Evolution API for a specific instance and remote JID

List SDR contacts with data cross-referencing

Returns paginated list of unique contacts (grouped by session_id) with LEFT JOIN to Person and Sell tables for data enrichment. Includes aggregated metrics: totalContacts, activeContacts, conversionRate, totalMessages.

Get client info by session ID

Returns client information by session ID with LEFT JOIN to Person and Sell tables. Includes phone extraction, status calculation, and sales aggregation. Returns fallback values when person not found.

Create SDR interaction

Cria uma nova interação SDR e atualiza a tabela sell com informações de contato e qualificação. **Identificação do Contato:** O agente SDR deve fornecer **UM** dos seguintes campos para identificar o lead: - `phone`: Número de telefone do lead (formato brasileiro, com ou sem código 55) - Exemplo: `”5511999999999”` ou `”11999999999”` - `session_id`: UUID da sessão web (formato: Lia-uuid) - Exemplo: `”Lia-2a08196b-ac9a-4984-9f78-a681cf3653c3”` - Use quando o contato veio do chat web (sem telefone disponível) **Campos Obrigatórios:** - `phone` OU `session_id` (um dos dois) - `channel`: Canal usado ('whatsapp', 'sms', 'email') - `result`: Resultado da interação ('interested', 'not_interested', 'no_response', 'callback_requested', 'converted') **Comportamento:** - Busca pessoa existente pelo telefone (com matching flexível) ou cria pessoa mínima se não existir - Para UUIDs web, cria pessoa mínima automaticamente - Cria/atualiza registro em `sdr_interactions` - Atualiza tabela `sell` com informações de contato e qualificação - Sincroniza dados entre ambas as tabelas automaticamente - Evita duplicatas (atualiza se houver interação recente para o mesmo telefone/pessoa) **Exemplos de Uso:** 1. **Contato por telefone - Lead interessado:** - Fornece `phone` - Define `contact: true` e `result: ”interested”` 2. **Contato por telefone - Lead qualificado:** - Fornece `phone` - Define `contact: true`, `sent: true`, `sent_to`, `converted_to_lead: true` 3. **Contato web (UUID) - Lead interessado:** - Fornece `session_id` (formato: Lia-uuid) - Define `contact: true` e `result: ”interested”` 4. **Contato web (UUID) - Lead qualificado:** - Fornece `session_id` - Define `contact: true`, `sent: true`, `sent_to`, `converted_to_lead: true`

Update SDR interaction status

Permite que sistemas externos (backoffice) atualizem o status das interações SDR usando telefone ou CPF como identificador. **Autenticação:** - Requer API Key via header `X-API-KEY` ou `Authorization: Bearer key` - NÃO usa JWT (endpoint externo) **Identificadores Suportados:** - `phone`: Número de telefone brasileiro (aceita: 5511999999999, 11999999999, (11) 99999-9999) - `cpf`: CPF do cliente (aceita: 12345678901, 123.456.789-01) **Status Disponíveis:** - `interested`: Lead demonstrou interesse - `not_interested`: Lead não demonstrou interesse - `no_response`: Sem resposta do lead - `callback_requested`: Lead solicitou retorno - `converted`: Lead convertido em cliente **Comportamento:** - Busca a pessoa pelo identificador (telefone ou CPF) - Localiza a interação SDR mais recente para essa pessoa - Atualiza o status da interação - Se notes fornecido, concatena em interaction_notes com timestamp - Mantém histórico (não sobrescreve notes anteriores)

Get SDR KPI metrics

Returns aggregated KPI metrics (contacts, conversion rate, leads, avg response time, response rate) with role-based authorization and caching.

Get SDR KPI trending data

Returns 30-day trending KPI metrics with daily breakdown, showing contact count, conversions, leads, and response rate per day.

Get Subscription Lead KPI metrics

Returns aggregated KPI metrics for subscription leads (total, by status, conversion rate, avg times).