From 4d8b4340b66f65e69d141832802f6676789f23b2 Mon Sep 17 00:00:00 2001 From: Jo Date: Fri, 4 Oct 2024 11:59:11 +0100 Subject: [PATCH 1/2] first draft --- .../Integrations/integrating-magento.mdx | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/studio/Integrations/integrating-magento.mdx diff --git a/docs/studio/Integrations/integrating-magento.mdx b/docs/studio/Integrations/integrating-magento.mdx new file mode 100644 index 00000000..a13f7c70 --- /dev/null +++ b/docs/studio/Integrations/integrating-magento.mdx @@ -0,0 +1,59 @@ +--- +title: Integrating Magento +nav_label: Integrating Magento +sidebar_position: 202.6 +--- + +You can quickly and easily integrate Studio with Magento. Once configured, using Studio's built-in Klevu integration, you can: + +- build a search page in Studio, enabling you to leverage the Klevu search engine in your Studio storefronts. +- build a page in Studio that uses a **Klevu recommendations** component to leverage Klevu Recommendations, designed to enhance your shoppers experience by providing personalized product suggestions. + + + +## Klevu Events + +Reporting user interaction with Klevu is crucial to allow the machine learning algorithms to accurately rank items. By reporting user interactions, such as clicks, searches, and purchases, Klevu's algorithms can better understand which products are most relevant to users. + +The Klevu integration is using two Klevu events, searches and clicks. Anytime a shopper searches uses the Studio search page and/or clicks on a product, you can see this in the Klevu dashboard. + +## Prerequisites + +You must have the following before configuring the Klevu integration in Studio. + +1. You must have a Shopify store with the following: + + - the Klevu app installed. If you don't have a Klevu account, it is automatically created when you install the Klevu app on your shopify store. + - configured a Studio account and associated it with the Shopify store. + +1. To configure the Klevu integration in Studio you need the following: + + | Option | Description | + |--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | **API key** |
  1. Go to your Klevu dashboard in your Shopify storefront.
  2. Go to **Store Settings**.
  3. In **API Key**, copy the API key.
| + | **Search URL** |
  1. Go to your Klevu dashboard in your Shopify storefront.
  2. Go to **Store Settings**.
  3. In **APIv2 Cloud Search URL:**, copy the search URL.
| + +## Integrating Klevu: An Overview + +Follow these steps to integrate with Klevu. + +1. In Studio, configure the [Klevu](#configure-the-klevu-integration) integration. +1. In Studio, create a [**Search**](/docs/studio/Integrations/klevu/search) page that uses a **Search** component. +1. In Studio, create a page that uses a [**Klevu recommendations**](/docs/studio/Integrations/klevu/recommendations) component. + +## Configure the Klevu Integration + +Follow these steps to configure the **Klevu** integration in Studio. + +1. Select **Settings** > **Integrations**. +2. Navigate to **Search**. +3. Select **+** next to **Klevu**. + Configure the settings. + + | Option | Description | + |:---------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | **Search URL** | Your Klevu Search URl in the format `https://klevuseachURl/cs/v2/search` where _klevusearchurl_ is the search URL you copied in [Prerequisites](#prerequisites). For example, `https://uscs33v2.ksearchnet.com/cs/v2/search`. | + | **API Key** | Your Klevu API key. See [Prerequisites](#prerequisites). | + +4. Select **Connect Account**. + From 433fef254334de1b8266a89818ee5fd9b613281b Mon Sep 17 00:00:00 2001 From: Jo Date: Mon, 7 Oct 2024 11:24:28 +0100 Subject: [PATCH 2/2] first draft --- .../Release-205-October-7-2024.md | 17 ++++++ .../Integrations/integrating-magento.mdx | 59 +++++-------------- 2 files changed, 32 insertions(+), 44 deletions(-) create mode 100644 changelog/Studio-Release-Notes/Release-205-October-7-2024.md diff --git a/changelog/Studio-Release-Notes/Release-205-October-7-2024.md b/changelog/Studio-Release-Notes/Release-205-October-7-2024.md new file mode 100644 index 00000000..39a3e5c2 --- /dev/null +++ b/changelog/Studio-Release-Notes/Release-205-October-7-2024.md @@ -0,0 +1,17 @@ +--- +title: Studio Release 205 | October 7, 2024 +date: 2024-10-7 +tags: + - Studio +--- + +#### Overview + +Support for integrating Magento with your Studio storefronts for Magento stores and bug fixes in this release. + +#### Magento + +You can quickly and easily integrate Studio with Magento. Magento is an open-source eCommerce platform used by businesses to create online stores and manage their digital sales operations. Once configured, using Studio's built-in Magento integration, you can display your Magento products on your pages in Studio. See [Integrating Magento](/docs/studio/Integrations/integrating-magento). + + + diff --git a/docs/studio/Integrations/integrating-magento.mdx b/docs/studio/Integrations/integrating-magento.mdx index a13f7c70..0dc1207d 100644 --- a/docs/studio/Integrations/integrating-magento.mdx +++ b/docs/studio/Integrations/integrating-magento.mdx @@ -4,56 +4,27 @@ nav_label: Integrating Magento sidebar_position: 202.6 --- -You can quickly and easily integrate Studio with Magento. Once configured, using Studio's built-in Klevu integration, you can: - -- build a search page in Studio, enabling you to leverage the Klevu search engine in your Studio storefronts. -- build a page in Studio that uses a **Klevu recommendations** component to leverage Klevu Recommendations, designed to enhance your shoppers experience by providing personalized product suggestions. - - - -## Klevu Events - -Reporting user interaction with Klevu is crucial to allow the machine learning algorithms to accurately rank items. By reporting user interactions, such as clicks, searches, and purchases, Klevu's algorithms can better understand which products are most relevant to users. - -The Klevu integration is using two Klevu events, searches and clicks. Anytime a shopper searches uses the Studio search page and/or clicks on a product, you can see this in the Klevu dashboard. +You can quickly and easily integrate Studio with Magento. Magento is an open-source eCommerce platform used by businesses to create online stores and manage their digital sales operations. Once configured, using Studio's built-in Magento integration, you can display your Magento products on your pages in Studio. ## Prerequisites -You must have the following before configuring the Klevu integration in Studio. - -1. You must have a Shopify store with the following: - - - the Klevu app installed. If you don't have a Klevu account, it is automatically created when you install the Klevu app on your shopify store. - - configured a Studio account and associated it with the Shopify store. +You must have the following before configuring the Magento integration in Studio. -1. To configure the Klevu integration in Studio you need the following: +| Option | Description | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Store URL** | | +| **Magento Consumer Key** | The **Consumer Key** is a unique identifier used by Studio to access your Mangento store via its API. | +| **Magento Consumer Secret** | The **Consumer Secret** is the password associated with the **Consumer Key**. | +| **Magento Access Token** | Once Studio is authenticated using the **Consumer Key** and **Consumer Secret**, the **Access Token** is used to grant ongoing access to your Magento store's data. | +| **Magento Token Secret** | The **Token Secret** is the password associated with the **Access Token**. | - | Option | Description | - |--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | **API key** |
  1. Go to your Klevu dashboard in your Shopify storefront.
  2. Go to **Store Settings**.
  3. In **API Key**, copy the API key.
| - | **Search URL** |
  1. Go to your Klevu dashboard in your Shopify storefront.
  2. Go to **Store Settings**.
  3. In **APIv2 Cloud Search URL:**, copy the search URL.
| +## Configure the Magento Integration -## Integrating Klevu: An Overview - -Follow these steps to integrate with Klevu. - -1. In Studio, configure the [Klevu](#configure-the-klevu-integration) integration. -1. In Studio, create a [**Search**](/docs/studio/Integrations/klevu/search) page that uses a **Search** component. -1. In Studio, create a page that uses a [**Klevu recommendations**](/docs/studio/Integrations/klevu/recommendations) component. - -## Configure the Klevu Integration - -Follow these steps to configure the **Klevu** integration in Studio. +Follow these steps to configure the **Magento** integration in Studio. 1. Select **Settings** > **Integrations**. -2. Navigate to **Search**. -3. Select **+** next to **Klevu**. - Configure the settings. - - | Option | Description | - |:---------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | **Search URL** | Your Klevu Search URl in the format `https://klevuseachURl/cs/v2/search` where _klevusearchurl_ is the search URL you copied in [Prerequisites](#prerequisites). For example, `https://uscs33v2.ksearchnet.com/cs/v2/search`. | - | **API Key** | Your Klevu API key. See [Prerequisites](#prerequisites). | - -4. Select **Connect Account**. +2. Navigate to **Storefront**. +3. Select **+** next to **Magento**. +4. Complete the fields in **Magento settings** with the information you gathered in [Prerequisites](#prerequisites). +5. Select **Connect Account**.