CUBO CRM
    CUBO CRM
    • Comece por aqui
    • Activities
      • Listar todas as atividades
        GET
      • Criar nova atividade
        POST
      • Obter atividade por ID
        GET
      • Atualizar atividade
        PUT
      • Excluir atividade
        DELETE
    • Annotation
      • Criar nova anotação
        POST
      • Obter anotação por ID
        GET
      • Atualizar anotação
        PUT
      • Excluir anotação
        DELETE
    • Apikey
      • Listar todas as apikeys
        GET
      • Criar nova apikey
        POST
      • Obter apikey por ID
        GET
      • Atualizar apikey
        PUT
      • Excluir apikey
        DELETE
    • Category
      • Listar todas as categorias
        GET
      • Criar nova categoria
        POST
      • Obter categoria por ID
        GET
      • Atualizar categoria
        PUT
      • Excluir categoria
        DELETE
    • Company
      • Obter empresa
        GET
      • Atualizar empresa
        PUT
    • Custom Field
      • Listar todos os campos personalizados
        GET
      • Criar novo campo personalizado
        POST
      • Obter campo personalizado por ID
        GET
      • Atualizar campo personalizado
        PUT
      • Excluir campo personalizado
        DELETE
    • Deal
      • Listar todos os negócios
      • Criar novo negócio
      • Obter negócio por ID
      • Atualizar negócio
      • Excluir negócio
    • Domain
      • Listar todos os domínios
      • Criar novo domínio
      • Obter domínio por ID
      • Excluir domínio
    • LostReason
      • Listar todos os motivos de perda
      • Criar motivo de perda
      • Obter motivo de perda por ID
      • Atualizar motivo de perda
      • Excluir motivo de perda
    • Organization
      • Listar todas as organizações
      • Criar nova organização
      • Obter organização por ID
      • Atualizar organização
      • Excluir organização
    • People
      • Listar todas as pessoas
      • Criar nova pessoa
      • Obter pessoa por ID
      • Atualizar pessoa
      • Excluir pessoa
    • Pipe
      • Listar todos os funis
      • Criar novo funil
      • Listar funil por ID
      • Atualizar Funil
      • Excluir funil
    • Product
      • Listar todos os produtos
      • Criar novo produto
      • Obter produto por ID
      • Atualizar produto
      • Excluir produto
    • Proposal
      • Listar todos as propostas
      • Criar proposta para negociação pelo ID
      • Obter proposta por ID
      • Atualizar proposta
    • Stage
      • Buscar todos os estágios do funil pelo ID
      • Criar estágios
      • Obter estágios por ID
      • Atualizar estágio
      • Excluir estágio
    • Template
      • Listar todos os templates de mensagem
      • Criar template de mensagem
      • Criar template de mensagem para negócio pelo ID
      • Obter template de mensagem por ID
      • Atualizar template de mensagem
      • Excluir template de mensagem
    • Webhooks
      • Receber dados do BotConversa para criação
      • Receber dados do BotConversa para atualização
      • Receber dados do ManyChat para criação
      • Receber dados do ManyChat para atualização

    Domain

    Entidade: Domain#

    Visão Geral#

    A entidade Domain 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#

    CampoTipoDescriçãoObrigatório
    idnumberIdentificador único do domínio✅ (auto)
    domainstringNome do domínio (ex: empresa.com)✅
    statusstringStatus do domínio (active, inactive)✅ (auto)
    companyIdnumberID da empresa proprietária✅ (auto)
    createdAtDateTimeData/hora de criação✅ (auto)
    updatedAtDateTimeData/hora da última atualização✅ (auto)

    Relacionamentos#

    Company: Empresa proprietária do domínio

    Integração com DigitalOcean#

    OperaçãoDescrição
    getAppRecupera configurações da aplicação
    createDomainAdiciona/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.
    Fluxo:
    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
    Benefícios:
    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.
    Fluxo:
    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
    Benefícios:
    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çãoDescriçãoMétodo HTTP
    ListarLista domínios da empresa com paginaçãoGET
    CriarRegistra um novo domínioPOST
    VisualizarRecupera informações de um domínioGET
    AtualizarAltera configurações do domínioPUT/PATCH
    ExcluirRemove domínio e suas configuraçõesDELETE

    Fluxo de Uso#

    Página anterior
    Excluir negócio
    Próxima página
    Listar todos os domínios
    Built with