Visão Geral#
A entidade Dominio representa domínios personalizados que podem ser associados às aplicações das empresas. Esta funcionalidade permite que as organizações utilizem seus próprios domínios para acessar o sistema, oferecendo uma experiência mais profissional e personalizada. A integração com DigitalOcean facilita o gerenciamento automático de DNS e configurações de domínio.Estrutura da Entidade#
Campos Principais#
| Campo | Tipo | Descrição | Obrigatório |
|---|
id | number | Identificador único do domínio | ✅ (auto) |
domain | string | Nome do domínio (ex: empresa.com) | ✅ |
status | string | Status do domínio (active, inactive) | ✅ (auto) |
companyId | number | ID da empresa proprietária | ✅ (auto) |
createdAt | DateTime | Data/hora de criação | ✅ (auto) |
updatedAt | DateTime | Data/hora da última atualização | ✅ (auto) |
Relacionamentos#
Company: Empresa proprietária do domínio
| Operação | Descrição |
|---|
getApp | Recupera configurações da aplicação |
createDomain | Adiciona/atualiza domínio na aplicação |
Casos de Uso Detalhados#
1. Configuração de Domínio Personalizado#
Cenário: Uma empresa deseja usar seu próprio domínio para acessar o sistema CRM.O administrador registra o domínio "crm.minhaempresa.com"
O sistema se conecta com DigitalOcean para configurar o DNS
O domínio é adicionado como ALIAS na aplicação
Os usuários podem acessar o sistema através do domínio personalizado
Experiência profissional e branded
Maior confiança dos usuários finais
2. Atualização de Domínio Existente#
Cenário: Uma empresa precisa alterar seu domínio devido a mudança de marca.O usuário atualiza o domínio de "antigo.com" para "novo.com"
O sistema verifica se o novo domínio não está duplicado
Remove a configuração antiga do DigitalOcean
Adiciona a nova configuração
Atualiza o registro no banco de dados
Transição suave entre domínios
Gerenciamento automático de DNS
Regras de Negócio#
Criação de Domínios#
Domínios são associados automaticamente à empresa do usuário autenticado
Status padrão é active na criação
Integração automática com DigitalOcean para configuração de DNS
Domínio é adicionado como tipo ALIAS na aplicação
Atualização de Domínios#
Verificação de duplicação antes da atualização
Remoção do domínio antigo da configuração DigitalOcean
Adição do novo domínio na configuração
Apenas domínios da própria empresa podem ser alterados
Exclusão de Domínios#
Remoção automática da configuração DigitalOcean
Exclusão permanente do registro
Somente domínios da própria empresa podem ser excluídos
Validações#
Nome do domínio deve ser único no sistema
Formato válido de domínio é obrigatório
Verificação de existência antes de operações
Operações Disponíveis#
| Operação | Descrição | Método HTTP |
|---|
| Listar | Lista domínios da empresa com paginação | GET |
| Criar | Registra um novo domínio | POST |
| Visualizar | Recupera informações de um domínio | GET |
| Atualizar | Altera configurações do domínio | PUT/PATCH |
| Excluir | Remove domínio e suas configurações | DELETE |
Fluxo de Uso#
Modificado em 2025-06-16 14:46:32
