VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Marca e configuração do tema

Presets e histórico

Lista e aplica presets prontos de visual, e consulta e restaura o histórico da configuração global.

Os presets são visuais prontos (cores e tipografia) que você aplica com uma chamada. Antes de qualquer aplicação ou restauração, a plataforma guarda a configuração atual no histórico, então dá para voltar. Exigem o privilégio manage_theme.

Listar presets

GET/api/v1/admin/theme/presetsAdmin

Lista os presets de visual disponíveis

Devolve os 4 presets fixos da plataforma: modern (Moderno), classic (Classico, sem acento, como o servidor devolve), minimal (Minimalista) e bold (Ousado). Os nomes e descrições são fixos, em português.

200Presets retornados
json
{
  "presets": [
    {
      "id": "modern",
      "name": "Moderno",
      "description": "Design limpo e contemporaneo com cores vibrantes e cantos arredondados",
      "thumbnail": "",
      "config": {
        "primary_color": "#2563eb",
        "secondary_color": "#7c3aed",
        "accent_color": "#06b6d4",
        "bg_color": "#ffffff",
        "text_color": "#0f172a",
        "font_family": "Inter, sans-serif",
        "border_radius": "8px"
      }
    }
  ]
}

Campos da resposta

presets[].idstring
modernclassicminimalbold
Código do preset, usado na aplicação.
presets[].namestring
Nome exibido.
presets[].descriptionstring
Descrição curta.
presets[].thumbnailstring
Miniatura (URL ou imagem embutida). Pode ser vazia.
presets[].configobject
Configuração completa do preset, com os campos de Ler a configuração (o exemplo mostra só alguns).

Aplicar preset

POST/api/v1/admin/theme/presets/{id}/applyAdmin

Aplica um preset à configuração global e ao estilo ativo

Guarda a configuração atual no histórico (nota Before applying preset: <nome>), grava os campos do preset, remove os tokens de cor antigos do extended_config (para que as cores do preset vençam; tokens que não são de cor ficam) e copia o resultado para o estilo ativo do tema ativo, para que a vitrine mude de verdade.

Parâmetros de caminho

idstringobrigatório
modernclassicminimalbold
Código do preset.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/theme/presets/modern/apply" \
  -H "Authorization: Bearer $TOKEN"

A resposta 200 é a configuração resultante, no formato de Ler a configuração.

Listar o histórico

GET/api/v1/admin/theme/historyAdmin

Lista os retratos anteriores da configuração

Da entrada mais nova para a mais antiga.

Parâmetros de consulta

limitintegerpadrão: 20
Quantidade de entradas, de 1 a 50. Valor fora disso (inclusive acima de 50) volta a 20.
200Histórico retornado
json
{
  "entries": [
    {
      "id": "388efc42-d13c-487e-92fa-30def8b2c125",
      "config": { "store_name": "Loja de Demonstração Venddor", "primary_color": "#2563eb" },
      "changed_by": "67bf291c-0846-4053-9528-8cfd5ab0ebf1",
      "note": "Before installing template: Laranja Energia",
      "created_at": "2026-07-13T17:10:22.840767Z"
    }
  ],
  "total": 1
}

Campos da resposta

entries[].iduuid
Identificador da entrada. É o id da restauração.
entries[].configobject
Configuração completa naquele momento (o exemplo mostra só alguns campos).
entries[].changed_byuuid
Usuário que fez a alteração seguinte.
entries[].notestring
Motivo do registro, em inglês: Before applying preset: ..., Before restoring from history, Before importing theme, Before installing template: ....
entries[].created_atstring
Momento do registro (RFC 3339, UTC).
totalinteger
Entradas devolvidas.

Restaurar do histórico

POST/api/v1/admin/theme/history/{id}/restoreAdmin

Volta a configuração para um retrato anterior

Guarda a configuração atual no histórico (nota Before restoring from history), regrava todos os campos do retrato e copia o resultado para o estilo ativo do tema ativo.

Parâmetros de caminho

iduuidobrigatório
Id da entrada do histórico.

A resposta 200 é a configuração restaurada.

Erros

StatusQuandoCorpo
401Sem token ou token expirado{"error":"missing authorization header"}
403Sem o privilégio manage_theme{"error":"insufficient privileges","required":"manage_theme"}
500Preset inexistente; entrada de histórico inexistente ou id que não é UUID{"error":"failed to apply preset","detail":"preset not found: zzz"}
O preset reescreve a marca

Os presets definem só cores e tipografia, mas a aplicação grava o conjunto completo de campos da configuração. Pelo código, logo_url, favicon_url e store_name são gravados com o valor que o preset traz, que é vazio. Depois de aplicar um preset, leia a configuração e, se esses campos estiverem vazios, reenvie-os com PUT /api/v1/admin/theme. O histórico guarda o retrato anterior para consultar os valores antigos.

Veja também

  • Ler e alterar a configuração
  • Exportar e importar
Anterior
Ler e alterar a configuração
Próxima
Exportar e importar
Nesta página
  • Listar presets
  • Aplicar preset
  • Exemplo de requisição
  • Listar o histórico
  • Restaurar do histórico
  • Erros
  • Veja também