3. Integrating the VTEX Login
This documentation is currently under development.
In this guide, you'll learn how to integrate the VTEX Login with your FastStore project.
The VTEX Login is provided by the
vtexcommercestable environment and uses a subdomain. Therefore, to successfully integrate the VTEX Login with your FastStore project, you must add a redirect back to the FastStore domain and set up the necessary auth cookies to authenticate client requests and maintain session information. This way, once shoppers finish logging in to your store, they can be redirected back to your website's main domain.Before you begin
All stores
- Ensure you have already configured the custom domain name of your FastStore website.
Stores currently using Portal (Legacy) technology
- We recommend using a subdomain for the initial setup to avoid login issues caused by redirecting from Portal to the main domain.
- You need to update your
vtex.edition-business@0.xtovtex.edition-store@5.xand migrate your secure domain to VTEX IO. To make these changes, please contact the VTEX support team and request an update to the Edition App installed in your account, as well as a migration of your secure domain from Portal (Legacy) to VTEX IO.
Step by step
Step 1 - Adding a redirect back to your FastStore domain
By the end of this step, changes will be live to all end-users, meaning that once shoppers finish logging in to your store, they will be redirected back to your website's main domain.
-
Access the VTEX Admin.
-
Go to Storefront > Layout.
-
In the left-side navigation menu, click on CMS.
-
Click on HTML Templates and open the Home file.
-
Add the following script to the Home's
<head>.- Replace the value between curly brackets with your store domain.
_10<meta http-equiv="refresh" content="0; URL='https://{maindomain}'" /> -
Clean the
<body>section to remove unnecessary code. By the end of this step, your Home file should look like the following:
- Click on the Save Template button.
Step 2 - Setting the auth cookie root domain
To authenticate client requests and maintain session information, you must ensure that the auth cookies are set up for the Login subdomain. To do that, open a support ticket with VTEX to the Identity team requesting to set up the auth cookie root domain for your FastStore URL.