Atualizar um tema

POST 
/v1/tenants/branding/themes/:theme

Atualizar ou criar um tema para um domínio específico.

Request

Path Parameters

theme stringrequired
Domínio para o qual o tema será aplicado
Example: example.com

Header Parameters

Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e

application/json

Body

application string
Possible values: [CUSTOMER, OPERATOR]
Example: CUSTOMER
displayName string

Nome da aplicação, que sera apresentado na tela de login.

pageTitle string

Título que vai aparecer no browser do cliente.

palette

object

Definição das cores do sistema.

primary

object

Utilizada para representar a cor primária dos elementos do sistema para o usuário. Essa cor é mais frequentemente apresentada através das telas e componentes do sistema.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

error

object

Utilizado para representar elementos com alerta para o usuário, como uma falha de conexão ou acesso não autorizado.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

warning

object

Utilizado para representar potenciais ações de alerta/perigo ou importantes mensagens para o usuário.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

info

object

Utilizado para representar informações neutras e que não são necessariamente importantes.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

success

object

Utilizado para indicar mensagens de sucesso de uma ação que o usuário realizou.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

typography

object

Definição da tipografia do sistema.

fontFamily string

Example: Roboto

fontUrl string

Example: https://your-external-front.io

images

object

logoUrl string

Logo principal da aplicação. Apresentada na tela de Login.

darkBackgroundLogoUrl string

Logo de contraste do sistema, utilizada no Header de cada aplicação.

loadingImageUrl string

Utilizada no componente de carregamento da aplicação. Pode ser gif, png ou jpg.

faviconUrl string

Favicon da aplicação.

loanStatus

object

Utilizado para representar as cores de cada status de uma proposta.

palette

object

success

object

Representa status de sucesso de uma proposta, como o caso do desembolso para o cliente.

main string

Cor principal a ser aplicada.

contrastText string

Cor de contraste do texto em relação a cor principal.

pending

object

Representa o status de proposta pendente, como é o caso de uma proposta em análise.

main string

Cor principal a ser aplicada.

contrastText string

Cor de contraste do texto em relação a cor principal.

rejected

object

Representa o status de uma proposta que foi rejeitada, como o caso de cancelamento.

main string

Cor principal a ser aplicada.

contrastText string

Cor de contraste do texto em relação a cor principal.

analytics

object

gtm

object

containerId stringrequired

Id do container Google Tag Manager.

Example: GTM-XXXXXX

privacyPolicy

object

title string

Título da política de privacidade. Texto utilizado no botão para abrir a política de privacidade.

Example: Política de Privacidade.

content string

Conteúdo da política de privacidade. Pode ser em formato de texto, HTML ou URL/Link, seguindo o padrão https://your-external-front.io.

Example: Ao utilizar o site, você concorda com a coleta e tratamento de dados pessoais.

customStyles

string

Propriedades personalizadas são entidades definidas por autores CSS que representam valores específicos a serem reutilizados em um documento.

property name*

string

property name* string

locales

object

Textos customizáveis. Estes textos customizáveis aceitam campos chave-valor. É possível personalizar alguns textos da aplicação conforme chaves da documentação.

property name*

object

Responses

200

OK

application/json

Schema

Schema

id string
Example: tenant01.base39.io
tenant string
Example: tenant01
application string
Possible values: [CUSTOMER, OPERATOR]
Example: CUSTOMER
displayName string

Nome da aplicação, que sera apresentado na tela de login.

pageTitle string

Título que vai aparecer no browser do cliente.

palette

object

Definição das cores do sistema.

primary

object

Utilizada para representar a cor primária dos elementos do sistema para o usuário. Essa cor é mais frequentemente apresentada através das telas e componentes do sistema.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

error

object

Utilizado para representar elementos com alerta para o usuário, como uma falha de conexão ou acesso não autorizado.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

warning

object

Utilizado para representar potenciais ações de alerta/perigo ou importantes mensagens para o usuário.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

info

object

Utilizado para representar informações neutras e que não são necessariamente importantes.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

success

object

Utilizado para indicar mensagens de sucesso de uma ação que o usuário realizou.

main string

Cor principal a ser aplicada.

Example: #00B894

light string

Cor de contraste.

Example: #00B894

dark string

Cor de contraste.

Example: #00B894

contrastText string

Cor de contraste do texto em relação as outras cores. Ex: Cor do texto em um botão.

Example: #00B894

typography

object

Definição da tipografia do sistema.

fontFamily string

Example: Roboto

fontUrl string

Example: https://your-external-front.io

images

object

logoUrl string

Logo principal da aplicação. Apresentada na tela de Login.

darkBackgroundLogoUrl string

Logo de contraste do sistema, utilizada no Header de cada aplicação.

loadingImageUrl string

Utilizada no componente de carregamento da aplicação. Pode ser gif, png ou jpg.

faviconUrl string

Favicon da aplicação.

loanStatus

object

Utilizado para representar as cores de cada status de uma proposta.

palette

object

success

object

Representa status de sucesso de uma proposta, como o caso do desembolso para o cliente.

main string

Cor principal a ser aplicada.

contrastText string

Cor de contraste do texto em relação a cor principal.

pending

object

Representa o status de proposta pendente, como é o caso de uma proposta em análise.

main string

Cor principal a ser aplicada.

contrastText string

Cor de contraste do texto em relação a cor principal.

rejected

object

Representa o status de uma proposta que foi rejeitada, como o caso de cancelamento.

main string

Cor principal a ser aplicada.

contrastText string

Cor de contraste do texto em relação a cor principal.

analytics

object

gtm

object

containerId stringrequired

Id do container Google Tag Manager.

Example: GTM-XXXXXX

privacyPolicy

object

title string

Título da política de privacidade. Texto utilizado no botão para abrir a política de privacidade.

Example: Política de Privacidade.

content string

Conteúdo da política de privacidade. Pode ser em formato de texto, HTML ou URL/Link, seguindo o padrão https://your-external-front.io.

Example: Ao utilizar o site, você concorda com a coleta e tratamento de dados pessoais.

customStyles

string

Propriedades personalizadas são entidades definidas por autores CSS que representam valores específicos a serem reutilizados em um documento.

property name*

string

property name* string

locales

object

Textos customizáveis. Estes textos customizáveis aceitam campos chave-valor. É possível personalizar alguns textos da aplicação conforme chaves da documentação.

property name*

object

Example (from schema)

{
  "id": "tenant01.base39.io",
  "tenant": "tenant01",
  "application": "CUSTOMER",
  "displayName": "string",
  "pageTitle": "string",
  "palette": {
    "primary": {
      "main": "#00B894",
      "light": "#00B894",
      "dark": "#00B894",
      "contrastText": "#00B894"
    },
    "error": {
      "main": "#00B894",
      "light": "#00B894",
      "dark": "#00B894",
      "contrastText": "#00B894"
    },
    "warning": {
      "main": "#00B894",
      "light": "#00B894",
      "dark": "#00B894",
      "contrastText": "#00B894"
    },
    "info": {
      "main": "#00B894",
      "light": "#00B894",
      "dark": "#00B894",
      "contrastText": "#00B894"
    },
    "success": {
      "main": "#00B894",
      "light": "#00B894",
      "dark": "#00B894",
      "contrastText": "#00B894"
    }
  },
  "typography": {
    "fontFamily": "Roboto",
    "fontUrl": "https://your-external-front.io"
  },
  "images": {
    "logoUrl": "string",
    "darkBackgroundLogoUrl": "string",
    "loadingImageUrl": "string",
    "faviconUrl": "string"
  },
  "loanStatus": {
    "palette": {
      "success": {
        "main": "string",
        "contrastText": "string"
      },
      "pending": {
        "main": "string",
        "contrastText": "string"
      },
      "rejected": {
        "main": "string",
        "contrastText": "string"
      }
    }
  },
  "analytics": {
    "gtm": {
      "containerId": "GTM-XXXXXX"
    }
  },
  "privacyPolicy": {
    "title": "Política de Privacidade.",
    "content": "Ao utilizar o site, você concorda com a coleta e tratamento de dados pessoais."
  },
  "customStyles": "background-color: '#00B894'",
  "locales": {
    "pt": {
      "otherLocales": [
        "pt-Br"
      ],
      "overrides": {
        "pix": "Pix",
        "amCet": "CET (a.m.)",
        "aaCet": "CET (a.a.)",
        "amTax": "Taxa (a.m.)",
        "aaTax": "Taxa (a.a.)",
        "iofValue": "Valor IOF"
      }
    }
  }
}

Loading...