Skip to content

Getting started

Welcome to the Voyado Elevate "Getting Started" guide! This guide will help you quickly familiarize yourself with Voyado Elevate and explore its features. Whether you're interested in trying out a demo or a full custom integration with Voyado Elevate, this guide will provide you with the necessary steps to get started.

Credentials

To access an Elevate environment and explore its capabilities, you need credentials. The credentials consist of three parts:

  • Cluster ID - A public Cluster ID pointing to the retailers Elevate service. The Cluster ID is used for the site integration.
  • Api Key - A private key. The private key is used when importing data and notifying customer interactions, such as orders to Elevate.
  • Elevate apps invitation mail - Used to access the web-based apps for reporting and merchandising.

Here is an example of how the Cluster ID and Api Key may look. Note that these examples are for illustrative purposes only, use the actual keys provided to you. Throughout this documentation, these example credentials are used as placeholders. When accessing specific environments, make sure to use the corresponding keys provided to you by Voyado.

Cluster ID: w1A2B3C45
Api Key (private): pkA123456789AB1BDA3E968F69A97B5508BF5B123456778912FFC99

Custom data

To upload your own products, you'll need an isolated cluster. Contact info@voyado.com to request your Elevate environment. Once set up, you will receive an invitation email to the Elevate Apps. Cluster credentials can be found in the Integration App.

Configure markets and locales for your cluster via the Admin App or an import. After configuring your cluster, you can import custom catalog data using the standard HTTP POST protocol.

For import examples, refer to the Catalog Import Examples. The full specification is available in the Admin API Specification.

If the import completes successfully without any errors, you will receive a 204 OK response, confirming the data has been loaded.

The following example shows how to replace all catalog data in Elevate using your credentials and the catalog import file my-data.gz.

curl -i \
-X PUT \
-H 'Api-Key: pkA123456789AB1BE..' \
-H 'Accept-Encoding: gzip' \
-H 'Content-Encoding: gzip' \
-H 'Content-Type: application/jsonlines' \
"https://w1A2B3C45.elevate-api.cloud/api/admin/v4/import/catalog" \
-T my-data.gz

Cluster Settings

You can also test the demo site with your custom data. Connect the demo site to the public part of your cluster to view your data as soon as it’s loaded. You can use this setup as a tool for debugging, throughout the integration.

Elevate demo site settings

To connect the demo site to your cluster, go to the Cluster Settings and enter the Cluster ID of your cluster and select a market and locale combination from the dropdown menu. Once you've made these changes, press the activate button and explore the newly uploaded products by trying out searches and other interactions.

Next steps

The quality of the results depends on the catalog import quality and the notified user behavior, captured through real interactions. An accurate integration with proper UX also greatly impacts the quality and influences which features that can be enabled.

Voyado Elevate also offers data classification and image analysis. Note that related features, such as enhanced color search, may require activation by Voyado and some processing time before becoming active.

Next, proceed to the Integration section to continue your setup with Voyado Elevate.

×
Copyright

This online publication is intellectual property of Voyado Lund AB. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Voyado Lund AB nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Voyado Lund AB essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE