Configurações

Retorna as configurações do painel do cliente

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: POST /api/v1/cliente/autenticacao (documento e senha do cliente) ou POST /api/v1/cliente/autenticacao/sindico (síndicos). ⚠️ O token de integração das APIs v2/v3 (POST /api/v3/auth/token) não é válido para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.

Retorna uma única configuração que estiver ativa

get/configuracoes

Request

  • Base URL
    https://integracao.cvcrm.com.br/api/v1/cliente
  • URL
    https://integracao.cvcrm.com.br/api/v1/cliente/configuracoes
  • Auth
    none declared

Query parameters

slugstring

Informa o domínio do portal

Response

Configurações

menustring
idconfiguracaointeger
mensagem_informacoes_financeirasstring nullable

Example response

{
  "menu": "horizontal",
  "cor": {
    "primaria": "#225b27",
    "secundaria": "#7f8154"
  },
  "idconfiguracao": 53,
  "logo": {
    "nome": "favicon.jpg",
    "tipo": "image/jpeg",
    "tamanho": 2462,
    "url": "https://localhost.cvcrm.com.br/api/get/imagens/painel_client"
  },
  "tela_login": {
    "titulo": "Olá!",
    "subtitulo": "Seja bem vindo ao portal do Cliente",
    "padrao_reset_senha": "email",
    "reset_senha_disponivel": "email",
    "exibir_acesso_sindico": true,
    "turnstile_site_key": "0x4AAAAAACrwyIdTjdU4PO6K"
  },
  "exibir_menu": {
    "agendamentos": true,
    "atendimentos": true,
    "assistencia_tecnica": true,
    "pesquisas": true,
    "indicar_amigo": true,
    "confirmar_endereco": true,
    "propostas_pendentes": true,
    "perguntas_frequentes": true,
    "previsao_entrega": true,
    "novidades": true
  },
  "exibir_financeiro": {
    "imposto_de_renda": true,
    "extrato_financeiro": true,
    "boletos": true,
    "boletos_avulsos": true,
    "boletos_antecipacao": true,
    "boletos_cv": true,
    "extrato_financeiro_cv": true,
    "informe_rendimentos_cv": true,
    "coluna_extrato_valor_original": true,
    "coluna_extrato_valor_de_baixa": true,
    "coluna_extrato_acrescimo": true,
    "coluna_extrato_desconto": true,
    "botao_saldo_devedor": true
  },
  "modulos": {
    "agendamentos": true,
    "atendimentos": true,
    "pesquisas": true,
    "sienge": true,
    "assistencia_tecnica": true
  },
  "plugins": [
    {
      "idextensao": 20,
      "ativo_painel": "S",
      "ativo": "S",
      "data_cad": "2025-09-17 14:30:48",
      "nome": "teste",
      "link": "/plugins/informakon",
      "icone": "fa-financeiro",
      "tipo": "iframe",
      "cliente": "S",
      "gestor": "S",
      "associado": "S",
      "painel_exibicao": "C"
    }
  ],
  "especifico_cv": {
    "exibir_id_item_assistencia": true,
    "cadastro_painel_cliente": true,
    "esqueci_senha_painel_cliente": true,
    "modo_esqueci_senha_painel_cliente": "email",
    "exibir_extrato_portal_cliente": true,
    "senha_portal_cliente": {
      "regex": "^(?=.*[0-9])(?=.*[!@#$%^&*])(?=.*[A-Z])[a-zA-Z0-9!@#$%^&*+.\\",
      "mensagem": "A senha deve estar entre 8 e 30 caracteres e deve possuir le"
    },
    "retirar_coluna_parcelas_extrato_sienge": true,
    "patrimonio_afetacao_ativo": true,
    "analytics": "UA-35126492-2",
    "exibir_multiplos_portais": true,
    "sessao_documentos": "Arquivos especiais",
    "urlGoogleApiMaps": "https://maps.googleapis.com/maps/api/js?key=AIzaSyCC0vNnyPQP"
  },
  "assistencias": {
    "exibir_localidade": true,
    "exibir_area_comum": true,
    "habilitar_nova_tela": true
  },
  "ordem_menu": [
    {
      "rota": "contratos",
      "nome_descricao": "Meus Contratos",
      "painel_exibicao": "Cliente"
    }
  ],
  "logo_login": {
    "nome": "logo_empresa.png",
    "tipo": "image/png",
    "tamanho": 2462,
    "url": "https://localhost.cvcrm.com.br/assets/img/logo_empresa.png"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.