Menu
Feedback
Comece aqui


Guia de onboarding
Trilha da loja VTEX
Configurações iniciais
Configurações iniciais
7 min de leitura

Este artigo apresenta como obter acesso ao ambiente VTEX e inclui informações desde a assinatura do contrato com a VTEX até as configurações iniciais da loja.

Antes de começar, é importante conhecer os principais termos utilizados no artigo, conforme apresentado na tabela abaixo:

TermoDefinição
Admin VTEX / Ambiente VTEXPlataforma de gerenciamento da experiência do comércio digital.
Master Service AgreementSão as políticas que regem o uso dos serviços da plataforma de comércio eletrônico VTEX, conforme os termos do contrato firmado entre a contratante e a contratada.
Anexo 1 - Order formDocumento complementar ao Master Service Agreement que é encaminhado à contratante para assinatura digital, contendo as informações do acordo comercial e informações jurídicas da contratante e da VTEX.
AutenticaçãoÉ a ação de verificar quem é o usuário que está realizando o login.
AutorizaçãoDetermina o que um usuário pode fazer após ser autenticado.
Canal de vendaSão lojas onde sellers podem oferecer os produtos disponíveis em seu catálogo para venda.
Perfil de acessoÉ um conjunto de recursos criado para atender a um tipo comum de usuário.
Recursos do License ManagerRecurso é uma entidade associada a uma ação ou informação na infraestrutura da VTEX.
Sponsor accountA Sponsor Account é a conta responsável pelo desenvolvimento, manutenção e distribuição de Edition Apps. Seu objetivo principal é agilizar a instalação de vários aplicativos e configurações em um grupo definido de contas.

Assinar o contrato

O processo de contratação da VTEX ocorre entre representante de vendas VTEX, contratante e representante legal de ambas as partes. Finalizada a negociação, a contratante recebe uma solicitação de assinatura digital do Anexo 1 Order Form, que contém as seguintes informações:

  • Condições jurídicas estabelecidas na negociação.
  • Dados dos representantes legais da VTEX e da contratante.
  • Dados das testemunhas da VTEX e da contratante.
  • Link para o MSA (Master Services Agreement).

Após a assinatura do contrato, todos os envolvidos recebem uma cópia do MSA + Anexo 1 Order Form via email. Novos clientes devem visualizar o MSA (Master Services Agreement) e considerar a região na qual está situada a empresa.

Para os que já têm parceria firmada com a VTEX, o MSA pode ser encontrado no topo do Anexo 1 Order Form, ou na página de Contratos Anteriores, a depender da região e da data em que o Anexo 1 foi assinado.

Receber acesso ao Admin VTEX

Após a assinatura do acordo comercial, em até 10 dias úteis o usuário titular recebe por email o acesso ao Admin VTEX. O usuário titular é o principal responsável pela loja e o único a quem é dado acesso total a todas as seções do Admin VTEX, incluindo ações importantes de manutenção e autorização.

Inicialmente, as principais ações que somente o usuário titular pode realizar são:

Outras ações podem ser necessárias por este usuário e estão listadas no artigo Usuário titular.

Usuário titular não é o mesmo que Owner (Admin Super). O Owner (Admin Super) é um perfil de acesso do License Manager que define permissões concedidas a um usuário e pode ser atribuído a múltiplos usuários. No entanto, existe apenas um Usuário titular por conta.

Usuários e permissões

Todos os usuários administrativos cadastrados em uma conta VTEX podem executar ações a depender do perfil de acesso cadastrado e de suas respectivas permissões para acessar recursos da plataforma. Por exemplo, para realizar a ação de recuperar uma transação, o usuário precisa ter um perfil de acesso com permissão para utilizar o recurso View Payment Data.

Adicionar usuários administrativos

Novos usuários devem ser cadastrados no Admin VTEX pela página Gerenciamento da conta, seguindo os passos do artigo Gerenciar usuários. Nesta página, também é possível editar, excluir ou exportar usuários.

Definir perfis de acesso e permissões para usuários

Para definir as ações que um usuário pode realizar no Admin VTEX, basta seguir as instruções no artigo Perfis de acesso. É possível associar usuários a perfis de acesso predefinidos ou, caso exista a necessidade de perfis que agrupem permissões diferentes das predefinidas, criar perfis de acesso customizados.

Autenticação para plataforma e frente de loja

É necessário configurar qual método de autenticação será ofertado aos clientes para login na loja e aos usuários administrativos para login no Admin VTEX. A autenticação no ambiente VTEX pode ser realizada através de algumas opções: código de acesso e senha, que estão sempre disponíveis, e Google como opcional.

Para realizar o login na loja, a VTEX disponibiliza autenticação por código de acesso, senha, Facebook e Google, sendo possível habilitar um ou mais métodos de autenticação. O passo a passo para habilitar as soluções pode ser encontrado no artigo Autenticação.

Autenticação para integrações e desenvolvimento de apps

A autenticação é essencial em integrações via API para conectar sua conta VTEX com sistemas externos e no desenvolvimento de aplicativos para a plataforma VTEX. É a autenticação que garante o acesso autorizado do usuário a recursos da plataforma, por meio de credenciais como chaves de aplicação ou tokens.

A tabela abaixo apresenta quais são os três tipos de autenticação disponíveis:

Tipo de autenticaçãoDescrição
Autenticação de requisições a APIs usando chaves de aplicação (appKeys)

As chaves de aplicação (appKeys) são utilizadas para autenticar requisições a APIs da VTEX. Os administradores da loja podem criar essas chaves para diferentes integrações.

Mais informações em API authentication using application keys.

Autenticação de requisições a APIs usando tokens de usuário

Os tokens de usuário são usados para autenticar requisições a APIs, especialmente para aplicativos frontend desenvolvidos com VTEX IO.

Mais informações em API authentication using user tokens.

Autenticação de apps usando tokens de autenticação

O uso de tokens de autenticação (auth tokens) é necessário para autenticação no desenvolvimento de apps com VTEX IO.

Mais informações em App authentication using auth tokens.

Política comercial

Um conceito importante na VTEX é política comercial, que significa um conjunto de configurações, incluindo:

Em toda integração com um canal de venda, é necessário atrelar uma política comercial e, quando uma das configurações citadas anteriormente diferir para um novo canal, é necessário criar uma nova política comercial.

A depender de sua arquitetura na VTEX, a loja pode se beneficiar com mais de uma política comercial, ou associar estratégias de várias políticas comerciais a multilojas e ambientes adicionais. O artigo Contas e arquitetura apresenta em detalhes a relação entre estes conceitos.

Para criar uma política comercial e para contratar políticas comerciais adicionais, é necessário entrar em contato com o Suporte VTEX.

Edition Apps

Edition Apps são pacotes que reúnem configurações e aplicativos em um único conjunto. Eles são criados por Sponsor Accounts para facilitar a configuração de contas franquia. Alguns exemplos são Edition Store e Edition Business, oferecidos nativamente. Qualquer Edition App depende de vtex.edition-business ou vtex.edition-store.

Para alterar um Edition App, é necessário entrar em contato com o nosso suporte, e somente o Sponsor Account pode fazer modificações. Para criar um Edition App, é preciso atender aos requisitos presentes em Developing an Edition App.

VTEX IO CLI

O VTEX IO CLI (Command-line Interface) é uma ferramenta de linha de comando desenvolvida pela VTEX e uma parte importante da plataforma VTEX IO, que permite que equipes de desenvolvimento criem e personalizem lojas e aplicativos na plataforma VTEX.

Através do VTEX IO CLI, os desenvolvedores podem realizar uma variedade de tarefas relacionadas ao desenvolvimento, como:

  • Inicialização de projetos: a CLI permite criar e iniciar projetos na plataforma VTEX IO, definindo a estrutura inicial e as configurações básicas.
  • Desenvolvimento local: é possível desenvolver, customizar e testar aplicativos localmente antes de implementar na plataforma VTEX.
  • Implementação: a CLI facilita a implementação dos aplicativos na plataforma VTEX IO, permitindo atualizações e gerenciamento dos aplicativos de maneira eficiente.
  • Integração com o ecossistema VTEX: o VTEX IO CLI se integra com outros serviços e ferramentas da plataforma VTEX, facilitando a interação com APIs, bancos de dados e outros recursos.

A instalação do VTEX IO CLI depende do sistema operacional utilizado. Para instalar a ferramenta conforme o sistema operacional disponível, consultar as instruções no artigo Installing VTEX IO CLI.

Para conhecer os comandos e funcionalidades do CLI e começar a utilizá-lo, basta acessar os artigos Using VTEX IO CLI e Managing plugins.

Contribuidores
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Isso foi útil?
Sim
Não
Sugerir edições (GitHub)
Contas e arquitetura
« Previous
Integrações de backend
Next »
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