v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Configurações

Retorna as configurações do painel do cliente

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Retorna uma única configuração que estiver ativa

get/configuracoes

Query parameters

slugstring

Informa o domínio do portal

Response

Configurações

idconfiguracaointeger
menu'vertical' | 'horizontal' required

Orientação do menu

mensagem_informacoes_financeirasstring

Example response

{
  "idconfiguracao": 4,
  "menu": "vertical",
  "cor": {
    "primaria": "#68509d",
    "secundaria": "#2d9191"
  },
  "logo": {
    "nome": "construtor.jpg",
    "tipo": "image/jpeg",
    "dispositivo_exibicao": "desktop",
    "tamanho": 2672,
    "url": "https://relacionar.cvcrm.com.br/api/get/imagens/painel_cliente_logo/[[LARGURA]]/[[ALTURA]]/20210111152544_5ffc98284c62c.jpg"
  },
  "tela_login": {
    "titulo": "Titulo",
    "subtitulo": "Subtitulo",
    "padrao_reset_senha": "email",
    "reset_senha_disponivel": "ambos",
    "exibir_acesso_sindico": true,
    "banner": [
      {
        "nome": "logoeasy.jpg",
        "tipo": "image/jpeg",
        "tamanho": 3313,
        "servidor": "20210226104659_6038fbd3e2ed1.jpg",
        "url": "http://construtordevendas.localhost/api/get/imagens/configuracao_painel_cliente_banner_arquivos/"
      }
    ]
  },
  "exibir_menu": {
    "agendamentos": true,
    "atendimentos": true,
    "assistencia_tecnica": true,
    "pesquisas": true,
    "indicar_amigo": true,
    "portal_beneficios": true,
    "perguntas_frequentes": true,
    "confirmar_endereco": true,
    "propostas_pendentes": true
  },
  "exibir_financeiro": {
    "imposto_de_renda": true,
    "extrato_financeiro": true,
    "boletos": true,
    "boletos_avulsos": 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,
    "botao_download_extrato": true,
    "botao_envio_email": true
  },
  "mensagem_informacoes_financeiras": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "modulos": {
    "agendamentos": true,
    "atendimentos": true,
    "pesquisas": true,
    "sienge": true,
    "assistencia_tecnica": true
  },
  "plugins": [
    {
      "idextensao": 12,
      "ativo_painel": "S",
      "ativo": "S",
      "data_cad": "2021-07-02 15:14:44",
      "nome": "Portal do Cliente",
      "link": "http://plugin.com.br/",
      "icone": "fa-user",
      "tipo": "blank",
      "cliente": "S",
      "gestor": "S",
      "associado": "S",
      "tamanho_iframe": 700,
      "autenticacao": "token",
      "painel_exibicao": "C"
    }
  ],
  "especifico_cv": {
    "ocultar_visualizacao_detalhada_extrato": true,
    "cadastro_painel_cliente": true,
    "esqueci_senha_painel_cliente": true,
    "primeiro_acesso_painel_cliente": true,
    "modo_esqueci_senha_painel_cliente": "email",
    "exibir_extrato_portal_cliente": true,
    "senha_portal_cliente": {
      "regex": "^.*(?=.{8,})(?=.*[a-zA-Z])(?=.*\\d)(?=.*[!#$%&?.,]).*$",
      "mensagem": "A senha deve estar entre 8 e 30 caracteres, e deve possuir pelo menos um número e um dos caracteres especiais."
    },
    "retirar_coluna_valor_boleto_sienge": true,
    "retirar_coluna_parcelas_extrato_sienge": true,
    "ocultar_etapa_portal_cliente": true,
    "ocultar_bloco_portal_cliente": true,
    "analytics": "UA-35123492-2",
    "exibir_multiplos_portais": true,
    "urlGoogleApiMaps": "https://maps.googleapis.com/maps/api/js?key=XXxxXxXX9xXxxXXXXxXxXxxxxxxXxXx9-9xXxxX"
  },
  "assistencias": {
    "exibir_localidade": true,
    "exibir_area_comum": true
  },
  "ordem_menu": [
    {
      "rota": "agendamentos",
      "nome_descricao": "Meus Agendamentos",
      "idextensao": 7,
      "tipo": "iframe",
      "painel_exibicao": "C",
      "icone": "Financeiro",
      "link": "http://plugin.com.br/exemplo",
      "associado": "S",
      "iconepc": "S"
    }
  ],
  "textos_personalizados": {
    "assistencia": "novo titulo da assistencia"
  }
}