Documentação das configurações de usuário

Visão Geral

As configurações de usuário permitem que cada pessoa salve conjuntos de filtros personalizados para qualquer listagem da plataforma.

A API armazena esses filtros já estruturados, junto com um nome definido pelo próprio usuário.

Ao acessar novamente a mesma listagem no painel, o sistema identifica o módulo atual e recupera os filtros salvos, permitindo que o usuário escolha rapidamente qual conjunto deseja aplicar.

Listagem de configurações do usuário

Descrição

Retorna a lista de filtros salvos pelo usuário nas listagens do painel Uappi.

Os identificadores das listagens são controlados pelo front-end, sendo que cada tela do painel possui seu próprio ID.

Ao carregar a listagem, o front-end envia o ID correspondente e verifica se existem filtros salvos para aquela listagem.

Parâmetros de Query

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/auth/users/setting \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "custom-user-setting-group": [
6      "admin-theme": "dark"
7    ]
8  }'

✅ Resposta de Sucesso

Na maioria dos casos, a API retorna um objeto contendo dois campos: label, que representa o nome atribuído pelo usuário ao conjunto de filtros, e value, que armazena o filtro codificado em Base64.

Esse formato é adotado pelo front-end como padrão, embora possa diferir conforme a listagem.

Exemplo:

1{
2  "status": true,
3  "data": {
4    "custom-user-setting-group": {
5      "admin-theme":"dark"
6    }
7  }
8}

Salvar Configurações de usuários

Descrição

Endpoint responsável por permitir o cadastro ou atualização dos filtros configurados por um usuário nas listagens do painel Uappi.

Os identificadores das listagens são controlados pelo front-end, sendo que cada tela do painel possui seu próprio ID.

Ao carregar a listagem, o front-end envia o ID correspondente e verifica se existem filtros salvos para aquela listagem.

Quanto ao valor retornado, na maioria dos casos o front-end trabalha com um objeto contendo dois campos:

• label, que representa o nome atribuído pelo usuário ao conjunto de filtros
• value, que armazena o filtro codificado em Base64

Esse formato é adotado pelo front-end como padrão, embora possa diferir conforme a listagem.

Parâmetros de query

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/auth/users/setting \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "id": "product-listing-tabs",
6    "value": {
7      "label":"nome", 
8      "value":"CODIFICAÇÃO EM BASE64"
9    }
10  }'

✅ Resposta de Sucesso

1{
2  "label":"nome", 
3  "value":"FILTRO EM BASE64"
4}

Excluir Configurações de usuários

Descrição

Endpoint responsável por permitir a exclusão de filtros configurados por um usuário nas listagens do painel Uappi.

Parâmetros de query

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/auth/users/setting/{settingId} \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2	"status": true,
3	"data": true
4}