Before you begin
If you use VTEX as your e-commerce platform, you can integrate Topsort directly into your VTEX store to offer ad placements to your vendors or sellers.
We cover the full Topsort integration cycle with VTEX (see Integration Overview), but it is not mandatory to set up all integrations exclusively with VTEX. This means you can set up one or two integrations, depending on your integration path discussed with your Topsort’s integration engineer.
Nonetheless, in this section we will cover the steps to integrate Topsort with VTEX using the VTEX IO Toolbelt. This integration is composed by the following apps:
- Catalog Integration
- Auctions Integration (Sponsored Listings)
- Events Integration
These apps work together to synchronize your catalog with Topsort, display sponsored products in search results, and track user interactions for reporting and optimization.
Prerequisites
Before you begin, ensure you have the following:
- A VTEX account with administrative access.
- The VTEX IO Toolbelt installed and configured.
- A Topsort account with a Marketplace API Key and an Advanced API Key. You can create these in your Topsort dashboard under
Settings > API Integration. (see Authentication Guide for more details). - Open your terminal and log in to your VTEX account:
vtex login {YOUR_ACCOUNT_NAME}Replace {YOUR_ACCOUNT_NAME} with your VTEX account name.
Integration steps
Depending on the integration path discussed with your Topsort’s integration engineer, you may need to set up one or more of the following apps:
- Catalog Integration
- Auctions Integration (Sponsored Listings)
- Events Integration
What’s next?
The VTEX IO apps don’t support automatic updates, so you will need to update the apps manually whenever a new version is released. Kindly keep an eye on the apps pages:
Whenever the app is outdated, you should see a notification similar to this:
If you have any questions or need assistance with the integration, feel free to contact us at support@topsort.com.