Installation Steps - Vtex

To access the backoffice, in the shop url add /admin and log in.

Go to Apps > App Store, search for "doofinder" and click on 'install'.

click on install

Please note that the region must be "eu1" or "us1", and the language must be the shortened locale, e.g. "en" or "es".

Post Installation

Once installed, you need to generate an API token that will be used later during the store creation. To do this, please go to:

Account Settings -> Account Management -> Application Keys -> Manage My Keys -> Generate New

Manage my keys

🗒 Note: When adding a new key, make sure that both values are saved, since the token value is only retrieved on creation and, for security reasons, can no longer be accessed.

Add a new key
Check keys values

Store Creation

Now it is time to create a Store in the Doofinder Admin Panel. If this is the first time you are installing it, a pop-up wizard will appear, and you just need to click on 'Create Store'. If not, click on the store icon in the top blue bar and hit the 'Create Store' button.

Enter your store URL and select "VTEX" from the platform drop-down menu, if it has not been added automatically after entering your URL. Click 'Continue'.

Enter your store URL

Select the settings of the store according to the ones that best suit your platform.

Enter your store settings

Now, enter your account name, the application key and the application token generated in the previous step. Click on 'Create'.

Please note that the account name needs to match the first part before the domain in which the admin is located. i.e:

  • Domain:
  • Account name: doofinderpartneres
Enter your keys information

Once all these settings are ready, the search engine will index your catalog.

Script and Layer Configuration

Once you have created the store and the search engine with the vtex wizard you can configure the layer.

In VTEX Backoffice, go to 'Apps', search for 'Doofinder and click on Settings. Paste your Store ID where it says 'Doofinder Installation ID' and save.

🗒 Note:Your Store ID is located in the Doofinder Admin Panel under Store Settings. Find more information here.

integrate your layer

Now you need to set the values, and you are ready to go. The values must be set in the IO edition of vtex. For the legacy edition, it should not be necessary, however it is highly recommended.

Please note, these values apply to the live-layer script, so you need to generate that script and set the installation ID, not the search engine.

Also, when creating the live-layer script, you will need to set the DOM value where the searches are written. In this case, the value we entered for the selector to find was.


You are now ready to go!