Menu
Feedback
Comece aqui
Tutoriais
Portal do desenvolvedor

Problemas conhecidos
Diretivas de suporte
Troubleshooting

Perguntas frequentes
Comunicados
Comece aqui
Guia de onboarding
Trilha da loja VTEX
Integrações de backend
24 min de leitura

Normalmente, as integrações começam com os softwares de back-office, permitindo o gerenciamento de partes essenciais da operação relacionadas a Catálogo, Preços, Logística, Pedidos. Os principais tipos de software presentes no back-office são:

  • ERP (Enterprise Resource Planning)
  • WMS (Warehouse Management System)
  • PIM (Product Information Manager)
  • CRM (Customer Relationship Management)

Além do back-office, pode-se integrar a plataforma de comércio eletrônico a outros sistemas que adicionam novos recursos. Um exemplo são os provedores de pagamento, que permitem a comunicação entre a plataforma VTEX e os provedores para realizar o processamento dos pagamentos e incluir métodos de pagamento adicionais no Checkout.

Integração com ERP

A configuração de integração do back-office de uma loja começa pelo software ERP (Enterprise Resource Planning). É possível que outros tipos de software sejam utilizados no back-office para finalidades específicas, como o PIM (Product Information Manager) lidando com dados de produtos, e o WMS (Warehouse Management System) lidando com inventário.

ERPs e outros tipos de softwares podem possuir integrações nativas com a VTEX. Caso não possua, será necessário implementar um middleware próprio utilizando as APIs da VTEX para integrar o software com a conta VTEX.

A configuração tem duas fases: a configuração inicial e a configuração de middleware. Após esta configuração, estará visível o fluxo em andamento, utilizado para a operação do dia a dia da loja. Veja mais detalhes sobre a configuração no Back office integration guide (ERP/PIM/WMS).

Configuração inicial

Nesta fase são feitos os procedimentos para que a conta VTEX receba todas as informações relacionadas aos produtos. Aqui serão integrados o catálogo, os produtos, os preços e o inventário da loja. Em geral, as configurações desta fase podem ser feita de três formas:

  • Integração com ferramentas externas.
  • Importação de planilhas.
  • Inserção manual pelo Admin VTEX.

Os passos de configuração desta fase devem ser seguidos na ordem apresentada abaixo. Os detalhes sobre cada passo estão descritos nas respectivas subseções da seção Integrações deste artigo.

  1. Arquitetura do Catálogo

a. Árvore de categorias

b. Marcas

c. Especificações (grupos e campos)

  1. Importação dos produtos

a. Importar produtos

b. Importar especificações dos produtos

c. Adicionar os produtos à política comercial

d. Importar SKUs

e. Importar especificações dos SKUs

f. Importar imagens dos SKUs

  1. Importação dos preços

a. Definir preço-base

b. Definir preços fixos para contextos específicos

  1. Importação do inventário

a. Criar estoques

b. Atualizar inventário de SKUs

Configuração de middleware

Nesta fase são feitos os procedimentos para permitir que a loja processe os pedidos. Aqui serão integradas as notificações sobre alterações dos pedidos e as ações para executar o processamento dos pedidos. A integração pode ser realizada de duas formas:

  • Integração de plataformas: esta opção envolve a utilização de uma plataforma de terceiros, conhecida como Platform-as-a-Service (PaaS), que já oferece uma solução pronta para integrar-se à VTEX, demandando um esforço mínimo de desenvolvimento.
  • Desenvolvimento interno: esta opção envolve a construção e manutenção do próprio software de integração. O middleware deve ser capaz de lidar com questões de escalabilidade que podem surgir com picos de vendas, como os que costumam acontecer em eventos de vendas como a Black Friday.

Os passos para esta configuração devem ser seguidos na ordem apresentada abaixo. Os detalhes sobre cada passo estão descritos nas respectivas subseções da seção Integrações.

  1. Configuração de integração/notificação de pedidos

a. Configurar feed ou hook

  1. Configuração de processamento de pedidos

a. Alterar pedido

b. Cancelamento

c. Faturamento

d. Rastreamento

Comportamento da integração com ERP

Após configurar a loja e fazer a integração com middleware, o fluxo geral de informações terá o seguinte formato:

{"base64":"  ","img":{"width":4951,"height":3231,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":652070,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/pt/tracks/vtex-store-overview/integracoes-de-backend_1.jpg"}}

Cada uma das requisições ou processos representados pelas setas no diagrama acima é acionada por um tipo diferente de evento na operação do dia a dia de um ecommerce. Para saber mais detalhes sobre esse fluxo, veja o Back office integration guide (ERP/PIM/WMS).

Integrações

Nesta seção, serão abordadas as principais integrações para o funcionamento de uma loja VTEX. Essas integrações abrangem uma ampla gama de aspectos, desde a integração de catálogo e dados de clientes até a gestão de pedidos e autenticação única (SSO). Cada uma dessas integrações será examinada a seguir.

Na VTEX, o Catálogo é o módulo para configurar as características dos produtos da loja de forma a tornar estes produtos disponíveis para os clientes. O Catálogo deve ser criado seguindo a ordem dos passos abaixo:

  1. Criação da árvore de categorias.
  2. Cadastro de Marcas.
  3. Cadastro de Especificações (opcional).
  4. Importação de Produtos.
  5. Importação de SKUs.
  6. Associação de especificações a produtos e SKUs.

Mais informações sobre configuração do Catálogo com back-office nos artigos Catalog e Set up catalog.

Árvore de categorias

Após compreender e planejar a Arquitetura do Catálogo da loja, a criação das categorias pode ser realizada pelas seguintes formas:

  1. Admin VTEX: criar cada categoria usando a interface de usuário. Veja os detalhes em Cadastrar Categorias.
  2. API do Catálogo: criar cada categoria fazendo chamadas de API. Veja os detalhes na API do Catálogo.
  3. Integração com back-office: importar as categorias a partir de um software externo de back-office (ERP ou PIM) integrado à VTEX. O software pode já oferecer integração nativa com a VTEX ou requerer o desenvolvimento de um middleware que utiliza a API do Catálogo. Veja os detalhes em Migração de Categorias a partir do ERP.

Ao importar as categorias de um software externo, a estrutura de categorias no software pode ser diferente da VTEX. Nesse caso, é recomendado criar uma categoria simulada inativa que não será visível no storefront e que pode ser usada para receber todos os produtos e SKUs durante a importação. Após a conclusão da importação, os produtos podem ser arranjados manualmente no Admin VTEX para se adequarem à árvore de categorias desejada.

Existem algumas limitações para lidar com categorias, são elas:

  • Mover categorias: embora seja possível mover categorias para diferentes níveis (mais alto/mais baixo) e/ou diferentes departamentos, isto é muito arriscado devido às especificações anexadas à categoria. Esta ação pode negativamente afetar informações sobre o produto, já que produtos herdam não apenas as especificações anteriores, mas também as novas.
  • Apagar categorias: não é possível apagar uma categoria a menos que se faça uma limpeza completa do catálogo da loja.

Mais informações sobre importação para back-office de categorias no artigo Categories.

Marcas

Marcas são atributos de produtos que ajudam os clientes a identificar o produto e a empresa responsável por ele. Um produto deve estar associado a uma única marca, o que significa que criar marcas é um passo obrigatório na configuração do Catálogo. É possível criar marcas das seguintes formas:

  1. Admin VTEX: criar cada marca usando a interface de usuário. Veja os detalhes em Cadastrar Marcas.
  2. API do Catálogo: criar cada marca fazendo chamadas de API. Veja os detalhes na API do Catálogo.
  3. Integração com back-office: importar as marcas a partir de um software externo de back-office (ERP ou PIM) integrado à VTEX. O software pode já oferecer a integração nativa com a VTEX ou pode requerer o desenvolvimento de um middleware que utiliza a API do Catálogo. Veja os detalhes em Criar Marcas no guia de configuração do Catálogo para back-office.

Caso o sistema de back-office não possua informação sobre marcas, pode ser feito o mesmo procedimento mencionado acima para migração de categorias, criando uma marca simulada inativa, exclusivamente para fins de migração. Posteriormente, as informações dos produtos podem ser inseridas manualmente.

Mais informações sobre importação para back-office de marcas para no artigo Brands.

Especificações

Especificações são propriedades adicionais que podem ser atribuídas a produtos e SKUs da loja para serem usadas na criação de filtros de busca e para diferenciar SKUs e produtos na página do produto. A criação de especificações pode ser realizada por meio de integrações de back-office utilizando a Catalog API.

Existem três tipos de especificações e elas devem ser criadas na seguinte ordem:

  1. Grupos de especificações
  2. Campos de especificação
  3. Valores de especificação

O diagrama abaixo ilustra este procedimento:

{"base64":"  ","img":{"width":2744,"height":1042,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":109414,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/pt/tracks/vtex-store-overview/integracoes-de-backend_2.png"}}

As especificações seguem a hierarquia do Catálogo. Quando um grupo é criado em um departamento ou categoria, ele será herdado nos níveis abaixo.

Após criar grupos, campos e valores, deve ser feita a associação de especificações a produtos e SKUs. Estes procedimentos estão descritos na próxima seção, Importar produtos.

Mais informações sobre importação para back-office de especificações no artigo Specifications.

Importar produtos

Importar produtos refere-se ao ato de transferir todas as informações relevantes do produto de um sistema ERP ou PIM para a plataforma VTEX. Esta etapa mantém o catálogo de produtos atualizado e sincronizado com a loja. Seja lidando com uma ampla variedade de produtos, SKUs ou variações diferentes, a importação eficaz de produtos é essencial para a experiência do cliente.

Na VTEX, é importante compreender a distinção entre Produtos e SKUs:

  • Produto: unidade abstrata do catálogo, visível nas prateleiras da loja.
  • SKU: unidade concreta do catálogo no estoque, representando as variações específicas de um produto, como cor, tamanho e outros atributos. Os SKUs são exibidos como itens individuais em páginas de produtos.

A maneira como produtos e SKUs são estruturados tem impacto direto na experiência de compra dos clientes.

A importação de produtos segue os passos na ordem da tabela abaixo:

AçãoDescriçãoMétodos
1. Importar produtosRegistrar os produtos no catálogo.
2. Importar especificações dos produtosPreencher as especificações dos produtos no catálogo.
3. Adicionar os produtos à política comercialAssociar os produtos às devidas políticas comerciais, definindo regras específicas (Preços, Pagamentos, estratégia de envio, etc.) de acordo com o canal de venda ou público. No mínimo, deve-se adicionar todos os produtos à política comercial principal.
4. Importar SKUsAdicionar SKUs aos produtos no Catálogo.
5. Importar especificações dos SKUsPreencher as especificações dos SKUs no Catálogo.
6. Importar imagens dos SKUsAdicionar imagens aos SKUs.

É comum que as informações de produtos no ERP não sejam adequadas para uso e exibição em um ecommerce. Por isso, deve ser feito um processo de enriquecimento, que pode incluir a reestruturação de categorias, e a criação de descrições de produtos mais descritivas e cativantes.

Após a importação, também é importante garantir que as informações sobre produtos e SKUs se mantenham atualizadas. Veja as instruções no artigo Update or delete information.

Mais informações sobre importação para back-office de produtos no artigo Import products.

Preços

Preços são as informações dos valores de venda dos SKUs, os quais são armazenados em tabelas de preços. Para garantir que os produtos da loja tenham preços competitivos e adaptados aos diferentes canais de vendas, é necessário compreender como as informações de preços são integradas à VTEX.

Em operações de venda, é comum delegar o cálculo do preço para o ERP, de onde esses dados podem ser importados. Os preços têm um valor base definido para cada SKU e podem variar de acordo com o contexto. Os passos para realizar a importação de preços são:

  1. Definir preço-base: o preço-base serve como referência para determinar o preço de um produto no sistema de precificação da VTEX. O preço-base de um SKU pode ser importado por integração utilizando a API de Preços ou criado pelo Admin VTEX.
  2. Definir preços fixos para contextos específicos: o preço-base pode ser ajustado ou modificado com base em regras específicas, cálculos ou preços fixos para chegar ao preço final de varejo do SKU em diferentes contextos, a depender da política comercial, grupo de clientes, promoção, entre outros fatores. Os preços fixos para contextos específicos podem ser importados por integração utilizando a API de Preços, importados por planilha ou criados pelo Admin VTEX.

Após a importação, também é importante garantir que as informações sobre preços se mantenham atualizadas. Veja as instruções no artigo Update or delete information.

Mais informações sobre importação para back-office de preços no artigo Import prices.

Inventário

No módulo Logística da VTEX, o inventário é a relação entre os itens de venda de uma loja (SKUs) e os locais onde estes itens estão armazenados, conhecidos como estoques. Gerenciar com eficiência o inventário de uma loja é uma etapa essencial para importar o inventário para a VTEX e garantir que os clientes possam acessar informações precisas de disponibilidade de produtos, agilizando o processo de logística e envio.

Os passos para realizar a importação de inventário são:

  1. Criar estoques: cadastrar os locais físicos ou virtuais onde os SKUs serão armazenados. Os estoques podem ser importados por integração utilizando a API de Logística ou criados pelo Admin VTEX.
  2. Atualizar inventário de SKUs: inserir a quantidade disponível de cada item nos estoques. O inventário pode ser importado por integração utilizando a API de Logística, por planilha de estoque ou atualizado pelo Admin VTEX.

Após a importação, também é importante garantir que as informações sobre preços se mantenham atualizadas. Para conferir as instruções, basta acessar o artigo Update or delete information.

Mais informações sobre importação para back-office de inventário no artigo Import inventory.

Dados de clientes

A importação de dados de clientes permite integrar informações de clientes de outros sistemas, como aplicações de CRM (Customer Relationship Management), com a VTEX. Por padrão, a VTEX armazena os dados dos clientes no Master Data V1.

Os dados no Master Data são organizados em entidades de dados, que podem ser comparadas a tabelas em outros sistemas de bancos de dados, contendo documentos que se assemelham a linhas ou registros. Os dados de perfil dos clientes são armazenados na entidade CL e os endereços dos clientes na entidade AD.

Os passos para realizar a importação de dados de clientes são:

  1. Criar novos perfis de clientes: criar documentos na entidade CL contendo os dados de perfil dos clientes, como nome, email, telefone, entre outros. Estes dados podem ser importados por integração utilizando a API do Master Data.
  2. Criar endereços: criar documentos na entidade AD contendo os endereços dos clientes, incluindo informações como rua, cidade, código postal, etc. Cada endereço é associado a um cliente, e um cliente pode ter vários endereços associados. Estes dados podem ser importados por integração utilizando a API do Master Data.

Mais informações sobre importação para back-office de dados de clientes no artigo Import customer data.

Integração de pedidos

Pedidos são gerados na plataforma VTEX assim que um cliente clica no botão de finalizar a compra no checkout. Cada pedido carrega várias informações, incluindo os itens do carrinho, o valor da compra, o método de pagamento, entre outros.

A integração de pedidos permite a comunicação entre a aplicação de back-office, ERP ou WMS, e o OMS (Order Management System) da VTEX. Tal integração desempenha um papel fundamental para:

Receber atualizações de pedidos

Com o back-office recebendo as atualizações dos pedidos, é possível agilizar e automatizar os procedimentos realizados no processamento de pedidos, como faturamento e cancelamento.

Existem duas formas de rastrear mudanças de status de pedidos na VTEX:

  • Feed v3: é uma lista de eventos sobre atualizações de pedidos. Para este tipo de integração, a VTEX fornece um endpoint para que o back-office possa realizar consultas aos itens da lista, processar os pedidos, e em seguida, remover os itens da lista.
  • Hook: é um canal para envio automático de notificações sobre atualizações de pedidos. Para este tipo de integração, a aplicação de back-office fornece um endpoint para que a VTEX o notifique sobre atualizações dos pedidos. Após receber uma notificação, o back-office procede com o processamento do pedido.

Para os dois tipos de integração, é possível aplicar filtros para selecionar os tipos de evento que devem ser processados pelo back-office.

Para a maioria dos casos, a VTEX recomenda a integração de pedidos pelo Feed v3 devido à sua resiliência.

Obter detalhes do pedido

Além das mudanças de status, a operação pode precisar obter informações adicionais sobre um pedido. As informações detalhadas de um pedido podem ser obtidas através da API de Pedidos, a qual pode ser utilizada em uma integração com o sistema de back-office desejado.

Os detalhes do pedido são utilizados em vários procedimentos no processamento de pedidos, como os itens do pedido para fazer o manuseio e o valor da compra para fins de faturamento.

Iniciar manuseio

Após os detalhes do pedido serem submetidos ao back-office, o passo final antes de iniciar o processamento de pedidos é alterar o status do pedido para Iniciar manuseio. Este procedimento pode ser integrado com o back-office pela API de Pedidos.

Mais informações sobre integração para back-office de pedidos nos artigos Set up order integration e Feed v3.

Processamento de pedidos

Nesta etapa, é configurada a integração para enviar atualização de pedidos do back-office, ERP ou WMS, para a VTEX. Durante o manuseio de um pedido, várias ações podem ser aplicadas, incluindo alteração, cancelamento e faturamento.

Abaixo se encontram os eventos que o back-office pode transmitir para a VTEX. A integração entre a VTEX e o back-office para a transmissão desses eventos é realizada por meio da API de Pedidos.

  • Alterar pedido: alterar itens ou valores do pedido.
  • Cancelar pedido: finalizar o pedido e cancelar o pagamento.
  • Faturar pedido: inserir a nota fiscal ao pedido. Essa é a indicação de que o pedido foi concluído com sucesso e está pronto para ser enviado.
  • Rastrear pedido: enviar as informações de rastreamento. Pode ser o código ou URL de rastreamento da transportadora, ou as notificações sobre atualizações no rastreamento.

Mais informações sobre configurar processamento de pedidos para back-office nos artigos Set up order processing e Change order.

SSO (Single Sign-On)

Single Sign-On é um sistema que permite a autenticação de usuários na plataforma utilizando um único conjunto de credenciais de login, eliminando a necessidade de fazer login separadamente em cada aplicativo. A VTEX oferece suporte à integração de provedores de identidade externos. Além das integrações nativas com serviços, como o Google, é possível criar novas integrações com outros provedores.

O VTEX ID é o serviço responsável por identificar os usuários na plataforma. Este serviço opera de acordo com a audiência, as regras de negócios, e o tipo de persona que pode interagir com cada módulo VTEX. As audiências disponíveis são:

AudiênciaContextoTecnologia
Admin VTEXIdentificação no painel administrativo VTEX, também conhecido como Admin VTEX, destinado a administradores e operadores da loja.SAML 2.0 (Security Assertion Markup Language).
WebstoreIdentificação no storefront VTEX, destinado a clientes da loja.OAuth 2.0 (Open Authorization).

Mais informações no artigo Login (SSO).

Pagamentos

Os sistemas de Pagamento da VTEX oferecem recursos extensivos para dar suporte a vários métodos de pagamento, condições e integrações. Os pagamentos na VTEX possuem as seguintes opções de fluxo de compra:

  • Transparente: o pagamento acontece diretamente no checkout, e o comprador escolhe o método de pagamento.
  • Redirecionamento: abre uma nova janela no navegador do comprador, onde o pagamento é processado por um serviço externo. Após finalizar o pagamento, o comprador retorna ao checkout para finalizar a compra.
  • Payment App: abre uma janela modal na página do checkout. Ao finalizar o pagamento, a janela se fecha e o fluxo da compra continua no checkout. Este fluxo também pode ser utilizado para o método de autenticação 3D Secure 2 (3DS2).

Para adicionar pagamentos em uma loja VTEX, existem as seguintes opções:

  • Provedor de pagamentos suportado nativamente: caso a VTEX ofereça a integração com o provedor de pagamentos desejado, é necessário possuir um contrato com o provedor e configurar as opções de pagamento através do Admin VTEX. Veja os detalhes sobre configurações no artigo Pagamentos e os provedores de pagamentos suportados pela VTEX na Lista de Provedores de Pagamentos por País.
  • Provedor de pagamentos personalizado: Caso o provedor de pagamentos desejado não possua uma integração com a VTEX, é necessário criar uma integração de pagamento utilizando o Payment Provider Protocol contendo os endpoints da API para se conectar com o nosso gateway de pagamentos. O conector pode ser implementado por uma agência parceira da VTEX. Para que o provedor seja disponibilizado na VTEX, é necessário testar a integração criada e passar pelo processo de homologação.

Mais informações sobre integrar um novo provedor de pagamentos no artigo Integrating a new payment provider on VTEX.

Vales-presente

Na VTEX, vales-presente, também conhecidos como gift cards, podem ser usados como uma opção de pagamento no Checkout, e como parte de programas de fidelidade. A VTEX fornece uma solução nativa de vales-presente e também suporta integrações com provedores de vale-presente externos.

Para adicionar vales-presente em uma loja VTEX, existem as seguintes opções:

  • Solução nativa de vales-presente: caso deseje utilizar a solução nativa de vales-presente da VTEX ou alguma integração já existente, deve-se configurar os vales-presente pelo Admin VTEX seguindo os passos do artigo Configurar Vale-presente.
  • Provedor de vales-presente personalizado: caso o provedor de vales-presente desejado não possua uma integração com a VTEX, é necessário implementar a própria integração utilizando o Gift Card Provider Protocol. Através deste protocolo, provedores podem desenvolver uma integração contendo os endpoints descritos na nossa Gift Card Provider Protocol API e conectar com o nosso Gift Card Hub.

Antifraude

O antifraude é um sistema especializado em analisar as compras realizadas nos sites, com o intuito de identificar operações fraudulentas. Na VTEX, primeiro a operadora do pagamento aprova a compra e, em seguida, o antifraude avalia o pedido.

Para adicionar um sistema de antifraude aos pagamentos de uma loja VTEX, existem as seguintes opções:

  • Sistema de antifraude suportado nativamente: caso já exista uma integração com o sistema de antifraude desejado na VTEX, é necessário possuir um contrato com uma das empresas parceiras e fazer a configuração no Admin VTEX. Mais informações nos artigos Configurar o antifraude e O que é antifraude?.
  • Sistema de antifraude personalizado: caso o sistema de antifraude desejado não possua uma integração com a VTEX, é necessário implementar a própria integração de antifraude utilizando o Antifraud Provider Protocol contendo os endpoints da Anti-fraud Provider API.

Extensões e apps

Além dos serviços essenciais oferecidos pela VTEX, é possível aprimorar as funcionalidades das lojas VTEX com a incorporação de extensões. Essas extensões são ferramentas que ampliam as capacidades da plataforma VTEX e oferecem diversas possibilidades, como adicionar provedores de pagamento e marketplace, personalizar o storefront, construir serviços de backend personalizados e criar novas aplicações para o Admin VTEX.

Uma das formas de inserir novas funcionalidades à plataforma VTEX é criando apps utilizando o VTEX IO, nossa plataforma de desenvolvimento responsável por proporcionar um gerenciamento de alto desempenho, escalabilidade e segurança robusta. Com o VTEX IO, desenvolvedores focam em construir soluções de negócio sem se preocupar com questões de infraestrutura.

O que é um app na VTEX

Um app na VTEX é uma aplicação construída utilizando o VTEX IO. Apps são um tipo de extensão, ou seja, também são responsáveis por estender as funcionalidades da plataforma VTEX. Apps podem ser desenvolvidos localmente, com código personalizado, e posteriormente integrados às lojas que operam na nossa infraestrutura. Apps também podem ser disponibilizados e adquiridos através da VTEX App Store.

Os tipos de apps disponíveis na VTEX são:

  • Storefront: temas de loja desenvolvidos com o Store Framework.
  • Frontend: componentes React que compõem temas de loja desenvolvidos com Store Framework.
  • Admin VTEX: módulos e funcionalidades para o Admin VTEX.
  • Serviços (backend): serviços Node ou .NET Core capazes de lidar com eventos e gatilhos, exportar rotas HTTP, e expor resolvedores GraphQL.
  • Pixel: scripts de serviços terceiros que são executados na frente de loja (frontend), provendo soluções como monitoramento de vendas, suporte ao usuário, coleta de dados e serviços de marketing.
  • Edition: conjunto de configurações, políticas, apps backend e frontend encapsulados e exportados por uma Sponsor Account.

Para conhecer as opções de implementação de apps, basta conferir a lista de builders.

Mais informações no artigo O que é um App VTEX.

O que levar em consideração ao escolher um app para ser instalado na sua loja?

Antes de iniciar o processo de desenvolvimento de um novo app, é recomendável explorar as soluções prontas para instalação na sua loja. Essas soluções podem ser encontradas no Hub de Extensões, o painel do Admin VTEX que centraliza o gerenciamento de extensões. No Hub de Extensões estão disponíveis os seguintes painéis:

  • App Store: marketplace onde estão disponíveis apps desenvolvidos pela VTEX e por terceiros. Neste painel é possível visualizar, adquirir e instalar apps para uma conta VTEX. Existem apps gratuitos e pagos, que possuem diversas formas de cobrança.
  • Gerenciamento de Aplicativos: página que permite instalar, desinstalar, remover e configurar apps na loja.

Veja alguns exemplos de soluções disponíveis na App Store:

  • Assembly Options: adiciona opções de anexos para personalização de SKUs. Por exemplo, adicionar uma frase em uma camiseta ou ingredientes em um sanduíche.
  • Gift List: permite criar listas de presente, que podem ser compartilhadas para que outras pessoas comprem os itens a serem presenteados. São úteis para eventos como aniversário, casamento e chá de bebê. Os itens comprados são transformados em créditos na loja, que podem ser utilizados para comprar quaisquer itens disponíveis na loja.
  • Live Shopping: permite a transmissão ao vivo no site da loja para engajar os clientes em tempo real. Cria oportunidades para promover produtos e possui vários componentes além do reprodutor de vídeo como número de espectadores, botão de curtir, chat em tempo real e barra lateral para apresentar produtos.
  • Apps de chat com clientes: adicionam um componente de chat para interagir com clientes. Podem possuir chatbot para interação automática, além de fornecer suporte humano. Alguns exemplos de apps são JivoChat, Tawk.to e Zendesk Chat.
  • Apps de análise e avaliação: adicionam componentes para que clientes avaliem os produtos da loja, geralmente por uma nota numérica ou um texto. Alguns exemplos de apps são Reviews and Ratings by VTEX, Bazaarvoice e PowerReviews.
  • Apps de mídias sociais: permite a interação com mídias sociais, por exemplo para divulgar os produtos da loja por anúncios na plataforma de mídia. Alguns exemplos de apps são TikTok for Business e Facebook Business Extension.

O que levar em consideração ao criar um app para a sua loja

Se a loja VTEX não encontrar um app que atenda às necessidades do seu modelo de negócio, existe a alternativa de desenvolver uma solução própria. Neste sentido, existem vários aspectos a serem considerados para desenvolver apps na VTEX:

  • Quem será responsável pelo desenvolvimento e manutenção? Os apps podem ser desenvolvidos e mantidos pelo time de desenvolvimento interno da empresa ou por uma agência certificada VTEX. Os parceiros de implementação da VTEX podem ser encontrados no nosso Partner Portal (somente português). Além do desenvolvimento, o responsável pelo app é encarregado da sua manutenção e atualizações.

  • Que tipo de app deve ser desenvolvido? É importante saber o contexto em que a solução desejada irá atuar. Os tipos de apps disponíveis estão descritos acima. Nós temos guias de “desenvolvimento para alguns tipos de apps como storefront, serviço e Pixel.

  • Como desenvolver um app? O desenvolvimento de um app é feito em várias etapas. Em geral, o processo de desenvolvimento segue os seguintes passos:

    a. Preparar o ambiente de desenvolvimento: os principais requisitos antes de começar a desenvolver um app são instalar a VTEX IO CLI (command-line interface) e criar um workspace de desenvolvimento na conta da loja.

    b. Interagir com o código: normalmente, o desenvolvimento se inicia a partir de um template inicial, seguido da implementação local no código. O template deve ser escolhido de acordo com o tipo de app desejado. É possível verificar os templates disponíveis rodando o comando da CLI vtex init. Além disso, é necessário configurar do arquivo manifest.json, onde são definidos vários parâmetros como o nome do app, o nome do desenvolvedor (vendor) e as permissões. Após a edição do código, o app é inserido no workspace de desenvolvimento pelo comando da CLI vtex link para realização de testes.

    c. Empacotar o código em uma nova versão: após os testes, deve-se seguir os passos para lançar uma nova versão do app e publicar um app. Isso permite que o código fique salvo na infraestrutura da VTEX e possa ser instalado em workspaces de produção.

    d. (Opcional) Validar se o meu app atende a minha necessidade de negócio: após ter a versão publicada, pode ser interessante instalar o app em um workspace de produção e realizar um teste A/B a fim de comparar a taxa de conversão das vendas considerando o seu novo app.

Caso queira aprender mais sobre o desenvolvimento de apps, recomendamos acessar o nosso Learning Center.

  • Deseja tornar o app disponível publicamente? É possível disponibilizar o app na App Store, permitindo que outras contas possam se alavancar da solução desenvolvida.
  • Deseja tornar o app disponível na App Store? Existem algumas vantagens em tornar o app disponível na App Store, como aumentar a visibilidade do seu app e a possibilidade de monetizá-lo. Para isso, é necessário seguir alguns passos e regras. Em resumo, deve-se tornar um desenvolvedor registrado, ter o código do app armazenado em um repositório do GitHub, desenvolver o app obedecendo as melhores práticas da App Store e submetê-lo ao processo de homologação. Após homologado, o app estará disponível na App Store.
Contribuidores
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Isso foi útil?
Sim
Não
Sugerir edições (GitHub)
Contribuidores
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Nesta página
Ainda tem dúvidas?
Pergunte à comunidade
Encontre soluções e compartilhe ideias na comunidade VTEX.
Junte-se à nossa comunidade
Solicite suporte à VTEX
Para assistência personalizada, entre em contato com nossos especialistas.
Abra um ticket de suporte
GithubDeveloper portalComunidadeFeedback