Configurações da Aplicação

Criar ou atualizar configuração de aplicação

Cria ou atualiza uma configuração de aplicação. As configurações podem incluir favicon, cor primária, alias de jornada, provedor de identidade e visibilidade do botão de inscrição. Isso permite personalizar a aparência e comportamento da aplicação.

post/open-keys/itp/api/v2/applications/{applicationId}/settings

Request

  • Base URL
    https://sandbox.openfinance.celcoin.dev
  • URL
    https://sandbox.openfinance.celcoin.dev/open-keys/itp/api/v2/applications/{applicationId}/settings
  • Auth
    OAuth 2
    Client credentials
    Token URL: http://localhost:8080/auth/realms/master/protocol/openid-connect/token scopes: user_owner_app, app

Path parameters

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

Request body

key'FAVICON' | 'PRIMARY_COLOR' | 'JOURNEY_DEFAULT_ALIAS' | 'IDENTITY_PROVIDER' | 'DISABLE_ENROLLMENT_BUTTON' required
		Tipos de chaves usadas para a customização da aplicação.

		- FAVICON: Url para carregar o Favicon.
		- PRIMARY_COLOR: Cor primária da aplicação usada na whitelabel.
		- JOURNEY_DEFAULT_ALIAS: Alias de Jornada default da aplicação
		- IDENTITY_PROVIDER: Provedor de identidade usada na whitelabel de gestão do usúario final
valuestring required

Valor para personalização

Example request

{
  "key": "FAVICON"
}

Response

successfully returned.

idstring required

O ID das configurações da aplicação.

createdAtstring required
updatedAtstring required
deletedAtstring required
applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

key'FAVICON' | 'PRIMARY_COLOR' | 'JOURNEY_DEFAULT_ALIAS' | 'IDENTITY_PROVIDER' | 'DISABLE_ENROLLMENT_BUTTON' required
		Tipos de chaves usadas para a customização da aplicação.

		- FAVICON: Url para carregar o Favicon.
		- PRIMARY_COLOR: Cor primária da aplicação usada na whitelabel.
		- JOURNEY_DEFAULT_ALIAS: Alias de Jornada default da aplicação
		- IDENTITY_PROVIDER: Provedor de identidade usada na whitelabel de gestão do usúario final
valuestring required

Valor para personalização

Example response

{
  "createdAt": "2024-01-01T20:32:44.581Z",
  "updatedAt": "2024-01-01T20:32:44.581Z",
  "deletedAt": "2024-01-01T20:32:44.581Z",
  "key": "FAVICON"
}

Changes

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