Skip to content

Busca de configurações personalizadas de template

GET /publics/template/custom-settings

Retorna configurações personalizadas do template

Descrição

Endpoint responsável por retornar as configurações de um template com base na URI informada 🌐.

A rota atua em contexto público e recebe a URI do template pela URL, utilizando esse identificador para localizar o template correspondente.

Internamente, o sistema carrega as configurações padrão do template, como título SEO, nome da loja, integrações (ex.: Google Tag Manager) e demais parâmetros estruturais.

Além disso, também são carregados apps vinculados ao template, responsáveis por integrações externas como autenticação via Google, Facebook e outros serviços.

Por fim, o endpoint aplica as configurações customizadas armazenadas no campo custom_settings, mesclando essas informações com as configurações padrão e os apps configurados.

O resultado é um objeto consolidado de configuração do template, que pode incluir campos estruturais e blocos de conteúdo, como elementos de layout contendo estruturas HTML utilizadas pelo frontend para renderização da interface.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Parâmetros do Corpo

ParâmetroTipoObrigatórioDescrição
uristring✅Uri do template cujo as configurações customizadas devem ser buscadas

Exemplo de Requisição

1curl --request GET \
2 --url https://sua-loja-uappi.com.br/api/v3/publics/template/custom-settings \
3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4 --data '{
5 "uri": "/checkout"
6 }'

✅ Resposta de Sucesso

1{
2 "apps": [
3 {
4 "code": "some-app-login",
5 "settings": {
6 "app-login-id": "123434634613"
7 }
8 }
9 ],
10 "settings":{
11 "config-1": "<header>...</header>",
12 "config-2": "<footer>...</footer>",
13 "other-config": "..."
14 }
15}

⚠️ Erro retornado:

1{
2 "status": false,
3 "data": {
4 "code": 403,
5 "errorCode": "UAPPI_RENDER_INVALID_TEMPLATE_LINK",
6 "message": "The template link is not valid."
7 }
8}

Uappi é a melhor opção para o crescimento da sua loja!

;