Pular para o conteúdo

Modelos

O motor vem com um conjunto selecionado de modelos: objetos QrConfig prontos que você chama por id. Use-os quando quiser um visual garantidamente bom sem precisar montar nada à mão.

Listar modelos

GET /api/qr/templates
{
  "success": true,
  "count": 118,
  "templates": [
    {
      "id": "champagne-onyx",
      "name": "Champagne on Onyx",
      "category": "luxury",
      "tags": ["dark", "monogram", "premium"],
      "preview": "https://api.qr-branding.com/api/qr/templates/champagne-onyx/preview"
    },
    { "...": "..." }
  ]
}

Filtrar por categoria

GET /api/qr/templates?category=luxury

O formato da resposta é idêntico ao da chamada sem filtro, mas inclui só as correspondências. As categorias não diferenciam maiúsculas de minúsculas e correspondem ao campo category de cada modelo. Veja a lista ao vivo em /examples, aba "Modelos".

Gerar a partir de um modelo

POST /api/qr/templates/{templateId}

O corpo é um subconjunto de QrConfig — tudo o que você definir substitui os padrões do modelo. A maioria das chamadas só substitui content, outputWidth e fileFormat.

Substituições comuns

CampoPor que substituir
contentA URL ou o texto a codificar — quase sempre substituído
outputWidthResolução de impressão (1200, 2400, 4096)
fileFormatpdf ou svg para impressão, png para tela
logoUrlColoque o seu logo sobre qualquer modelo
centerTextAdicione uma faixa "ADMIT ONE" / "SCAN ME"
ctaTextLegenda abaixo

Galeria visual

Todos os modelos renderizados lado a lado estão em /examples — a mesma galeria também vem incluída na referência visual para consulta offline.