Visão Geral#
A entidade Empresa representa as empresas dentro do sistema. Cada empresa possui seus próprios usuários, configurações e dados isolados, garantindo a segurança e privacidade das informações. O sistema implementa controle de acesso baseado em empresa, onde usuários só podem acessar dados da sua própria organização.Estrutura da Entidade#
Campos Principais#
| Campo | Tipo | Descrição | Obrigatório |
|---|
id | number | Identificador único da empresa | ✅ (auto) |
name | string | Nome da empresa | ✅ |
status | string | Status da empresa (active, inactive) | ✅ |
createdAt | DateTime | Data/hora de criação | ✅ (auto) |
updatedAt | DateTime | Data/hora da última atualização | ✅ (auto) |
Relacionamentos#
Usuários: Usuários pertencentes à empresa
Motivos de perda: Motivos de perda configurados pela empresa
Campos personalizados: Campos personalizados da empresa
Produtos: Produtos cadastrados pela empresa
Domínios: Domínios associados à empresa
Casos de Uso Detalhados#
1. Visualização de Empresa por Usuário da Própria Empresa#
Cenário: Um usuário deseja visualizar informações da sua empresa.O usuário faz uma requisição para visualizar a empresa
O sistema verifica se o companyId do usuário corresponde ao ID solicitado
Retorna todas as informações da empresa com relacionamentos carregados
Inclui usuários, motivos de perda, campos customizados e produtos
Acesso completo às informações da própria empresa
Visão consolidada de todos os recursos
2. Bloqueio de Acesso Não Autorizado#
Cenário: Um usuário tenta acessar informações de outra empresa.Usuário faz requisição para empresa diferente da sua
Sistema verifica que companyId não corresponde e usuário não é Administrator
Retorna erro 401 (Unauthorized)
Acesso é negado com mensagem explicativa
Segurança e isolamento de dados
Prevenção de vazamento de informações
Regras de Negócio#
Controle de Acesso#
Usuários só podem visualizar dados da própria empresa
Verificação automática de permissões em todas as operações
Relacionamentos Carregados#
Usuários: Lista todos os usuários da empresa
Motivos de perda: Motivos de perda personalizados
Campos personalizados: Campos customizados configurados
Produtos: Catálogo de produtos da empresa
Segurança#
Isolamento completo de dados entre empresas
Autenticação obrigatória para todas as operações
Logs de acesso para auditoria
Validações#
Verificação de existência da empresa
Confirmação de permissões antes do acesso
Tratamento de erros com mensagens apropriadas
Operações Disponíveis#
| Operação | Descrição | Método HTTP |
|---|
| Visualizar | Recupera informações completas da empresa | GET |
Fluxo de Uso#
Modificado em 2025-06-16 14:35:48
