Por onde começar


Nessa documentação você encontrará o que é necessário para a criação e manutenção de seu template na plataforma de e-commerce wBuy.

Os templates devem ser desenvolvidos em HTML (jutamente com CSS e JS) usando a tecnologia de template engine Twig em sua versão 2 (documentação do Twig).

Abaixo um exemplo de utilização do Twig juntamente com HTML:

<ul id="navigation">
    {% for item in navigation %}
    <li><a href="{{ item.href }}">{{ item.caption }}</a></li>
    {% endfor %}
</ul>

Neste exemplo está sendo possível popular uma lista com os dados do array navigation através de um for.


Também é possível obter uma prévia de todas as variáveis disponíveis para utilização com a função pr(). A função pr() recebe o Array desejado a visualizar, exemplo:

# buscando dados na api de categorias
{{ pr(api.categoryGetAll()) }}

O resultado é um array de dados no formato var_dump() do PHP encapsulado em uma tag <pre>.


Se você trabalha com uma IDE e quer desenvolver direto pelo seu computador, instale nosso pacote wBuy Watcher via NPM

https://www.npmjs.com/package/wbuy-watcher

Importante: Todo arquivo a ser salvo através do wBuy Watcher precisa estar na codificação ISO-8859-1.


As telas passíveis de personalização atualmente são:

  • Página inicial
  • Página de categorias
  • Página de busca
  • Detalhes do produto
  • Vitrines internas dinâmicas (rotas)
  • Página de produtos de Marca
Também é possível criar widgets separados, aos quais podem ser incluídos nos templates em qualquer parte utilizando a função include() do Twig, estes arquivos devem ser criados dentro do diretório Widgets e serem referenciados como o exemplo abaixo:
{{ include('widgets/carrinho-suspenso.html') }}

Como auxílio você pode usar nossa documentação da API para que seja possível obter os parâmetros de consulta.