Skip to content

Latest commit

 

History

History
64 lines (38 loc) · 2.31 KB

README.md

File metadata and controls

64 lines (38 loc) · 2.31 KB

Getting Started

Instalação

O vtex.js depende do jQuery, então certifique-se que ele está incluído na página antes do vtex.js.

Você pode incluir, em sua loja, todos os módulos do vtex.js:

<script src="//io.vtex.com.br/vtex.js/2.0.0/vtex.min.js"></script>

Ou incluir módulos individualmente:

<script src="//io.vtex.com.br/vtex.js/2.0.0/extended-ajax.min.js"></script>
<script src="//io.vtex.com.br/vtex.js/2.0.0/catalog.min.js"></script>
<script src="//io.vtex.com.br/vtex.js/2.0.0/checkout.min.js"></script>

Pronto! Agora você tem nos objetos vtexjs.catalog e vtexjs.checkout acesso a vários métodos para acesso às APIs da VTEX.

Apresentação

Veja os slides da apresentação sobre o vtex.js que rolou no VTEX Day 2014.

Módulos

O vtex.js é composto de vários módulos, que contém funções que servem para se comunicar com os serviços da VTEX.

Os módulos residem no objeto global vtexjs. Quando você inclui o script de um módulo, é criado um objeto com todos os métodos para acesso às APIs desse módulo. Por exemplo, ao incluir o módulo do Checkout, você agora tem o objeto vtexjs.checkout, com diversos métodos para acessar a API do Checkout.

Módulo Checkout - vtexjs.checkout

O módulo Checkout manipula dados referentes à compra do cliente.

Naturalmente, o Checkout agrega os mais diversos dados necessários para o fechamento de uma compra: dados pessoais, de endereço, de frete, de items, entre outros.

O OrderForm é a estrutura responsável por esse aglomerado de dados. Ele é composto de diversas seções, cada uma com informações úteis que podem ser acessadas, manipuladas e (possivelmente) alteradas. Se tiver qualquer dúvida quanto a suas seções, consulte a documentação do OrderForm.

Veja a documentação completa de todos os métodos desse módulo aqui.

Módulo Catalog - vtexjs.catalog

O módulo Catalog obtém dados referentes aos produtos da loja.

Veja a documentação completa de todos os métodos desse módulo aqui.

Desenvolvimento

Para poder desenvolver o vtex.js, baixe o repositório, instale as dependências e execute o comando:

sudo grunt

Agora o vtex.js já pode ser linkado a outros repositórios para desenvolvimento.