Menu
Feedback
Start here
Tutorials


Onboarding guide
VTEX store overview
Initial setup
Initial setup
7 min read

This article explains how to gain access to the VTEX environment and provides information from signing the agreement with VTEX to the initial store settings. Before you begin, you should know the main terms used in the article, as shown in the table below:

TermDefinition
VTEX Admin / VTEX environmentPlatform for managing the ecommerce experience.
Master Service AgreementThese are policies that regulate the use of the VTEX ecommerce platform services in compliance with the terms of the agreement signed between the contractor and the contracted party.
Appendix 1 - Order formSupplemental document that goes with the Master Service Agreement and is sent to the contractor to be digitally signed, containing information about the business agreement and legal information of the contractor and VTEX.
AuthenticationThe process of verifying the identity of the user that is logging in.
AuthorizationDetermines the actions a user can do after being authenticated.
Sales channelThese are stores where sellers can offer the products they have in their catalogs.
RoleIt is a set of resources created to serve a typical type of user.
License Manager resourcesResources are entities associated with an action or information in the VTEX infrastructure.
Sponsor accountThe Sponsor Account is the account that develops, maintains, and distributes Edition Apps. Its main purpose is to speed up the installation of many apps and configurations in a specific group of accounts.

Signing the agreement

The VTEX contractual process involves a VTEX sales representative, the contractor, and the legal representative of both parties. Once the negotiation is completed, the contractor receives a request to digitally sign the Appendix 1 Order Form, containing the following information:

  • Legal conditions agreed in the negotiation.
  • Details of the legal representatives of VTEX and the contractor.
  • Information of the VTEX witness and the contractor witness.
  • MSA (Master Services Agreement) link.

Once the agreement has been signed, all parties involved receive a copy of the MSA + Appendix 1 Order Form via email. New clients should review the MSA (Master Services Agreement) and consider the company location.

If you already have a partnership with VTEX, the MSA can be found at the top of the Appendix 1 Order Form or on the Agreements Archive page, depending on the region and the date the Appendix 1 was signed.

Gaining access to the VTEX Admin

After signing the commercial agreement, the sponsor user receives access to the VTEX Admin by email within 10 working days. The sponsor user is the store's main administrator and the only one with full access to all VTEX Admin sections, including important maintenance and authorization actions.

Initially, the main actions only the sponsor user can perform are:

Other actions may be restricted to this user, which are listed in the Sponsor user article.

Sponsor user is not the same as Owner (Admin Super). Owner(Admin Super) is a License Manager role that gives permissions to a user and can be assigned to multiple users. However, there is only one Sponsor user per account.

Users and permissions

All admin users listed on a VTEX account can perform actions depending on their role and permissions to access the platform's resources. For example, to restore a transaction, the user must have a role with permission to use the View Payment Data resource.

Adding admin users

New users must be added to the VTEX Admin via the Account Management page, following the steps in the How to manage users article. On this page, you can also edit, delete, or export users.

Setting roles and permissions for users

To define the actions a user can perform in the VTEX Admin, follow the instructions in the Roles article. You can assign predefined roles to users, or if you need roles that include different permissions from the predefined ones, you can create custom roles.

Platform and storefront authentication

You need to configure the authentication method that will be available to customers when logging in to the store and admin users when logging in to the VTEX Admin. Authentication in the VTEX environment can be done in several ways. For example, access code and password are always available, while Google is optional.

To log in to the store, VTEX provides authentication by access code, password, Facebook, and Google so that you can enable one or more authentication methods. The instructions for enabling these solutions can be found in the Authentication article.

Integration and app development authentication

Authentication is essential in API integrations for connecting your VTEX account with external systems and for developing apps for the VTEX platform. Authentication guarantees authorized user access to platform resources using credentials such as app keys or tokens.

The table below shows the three authentication types available:

Authentication typeDescription
Authentication of API requests using app keysApp keys are used to authenticate VTEX API requests. Store admins can create these keys for different integrations.

Learn more in the API authentication using application keys article.

| | Authentication of requests to APIs using user tokens | User tokens are used to authenticate API requests, especially for frontend apps developed using VTEX IO.

Learn more in the API authentication using user tokens article.

| | Authentication of apps using authentication tokens | The use of auth tokens is required for authentication when developing apps using VTEX IO.

Learn more in the App authentication using auth tokens article.

|

Trade policy

An important concept on VTEX is trade policy, which is a group of settings that includes:

In every integration with a sales channel, a trade policy must be linked, and when one of the settings mentioned above is different for a new channel, a new trade policy must be created.

Depending on its architecture on VTEX, the store can benefit from more than one trade policy or associate strategies from several trade policies with multistores and additional environments. The Accounts and architecture article explains the relationship between these concepts.

Edition Apps

Edition Apps are bundles that combine configurations and apps in a single set. They are created by Sponsor accounts to facilitate franchise account configuration. Some examples are Edition Store and Edition Business, which are provided natively. Any Edition App depends on vtex.edition-business or vtex.edition-store.

Contact our support team to change an Edition App, keeping in mind that only the Sponsor account can make changes. To create an Edition App, you must meet the requirements for Developing an Edition App.

VTEX IO CLI

VTEX IO CLI (Command Line Interface) is a command-line tool developed by VTEX and an important element of the VTEX IO platform, which allows development teams to create and customize stores and apps on the VTEX platform.

Through the VTEX IO CLI, developers can perform many tasks related to development, such as:

  • Creating projects: CLI allows you to create and start projects on the VTEX IO platform by defining the basic structure and settings.
  • Local development: You can develop, customize, and test apps locally before implementing them on the VTEX platform.
  • Implementation: The CLI streamlines the implementation of apps on the VTEX IO platform, efficiently updating and managing apps.
  • Integration with the VTEX ecosystem: VTEX IO CLI integrates with other services and tools on the VTEX platform, enabling interaction with APIs, databases, and other resources.

VTEX IO CLI installation depends on the operating system used. To install the tool based on the operating system available, see the instructions in the Installing VTEX IO CLI article.

To learn about the CLI's commands and features and to start using it, read the Using VTEX IO CLI and Managing plugins articles.

Contributors
3
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Introduction to VTEX
« Previous
Backend integrations
Next »
Contributors
3
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback