Optimizely + Yotpo Review

A High level guide to implement reviews in Optimizely Yotpo Review platform is a Reviews' Management Solution (RMS). It is used to capture authentic reviews and display them on the site. Reviews can be for a site / page / blog post / product or any section of the page.

In this article we’ll be focusing on the Yotpo Review Platform integration with Optimizely. 

For any ecommerce site it is important to have a feedback mechanism for the product the customer has purchased. Now it has become more important and faith building for the aspiring customer what existing consumers say about the product instead of content displayed for the item. After finding the product, referring to the reviews is one of the key factors to go for purchasing it. 

To get complete benefits of the article, it is recommended to have understanding / experience of Optimizely CMS and Commerce Project Development

Let's start with the Yotpo account creation. With account one default store is also created to which you can use to explore features.

For Signup you will be prompted for Yotpo products, select “Reviews”. This will open screens as mentioned below images and following the same sequence.

Step 1 - Create Review -

Step 2 - Customize Widget - 

Step 3 - Integrate it on page / site -

You can find step by step, detailed instructions for implementing review widget, customization and order placement at below link:

Generic (Other Platforms): Installing Yotpo Reviews (v1)

Now it's time to implement various APIs available for Review with Optimizely. Before moving to the next step. Lets explore below API documentation available from Yotpo.

https://develop.yotpo.com/reference/getting-started-1 https://apidocs.yotpo.com/reference/welcome https://core-api.yotpo.com/reference/welcome

Implementing Yotpo with Optimizely Commerce

• Create Yotpo Service Module Class

  • This call contains the all the settings and implementation code of Yotpo Review API with the CMS / Commerce Application

• Initialize & Register Yotpo Service Module Class in the initialization module

  • Once the Service class is ready now it's time to make it available CMS / Commerce. This can be done using the Optimizely Initialization System. This is documented in the Optimizely World and you can refer to this link for more details. https://docs.developers.optimizely.com/content-cloud/v11.0.0-content-cloud/docs/initialization

Below is the sample example of Initialization Module class

namespace Reviews { [InitializableModule]
  public class YotpoReviewsinit: IConfigurableModule {
    public void Initialize(InitializationEngine context) {}
    public void Uninitialize(InitializationEngine context) {}
    public void ConfigureContainer(Service Configuration Context context) {
      if (context == null) {
        throw new ArgumentNullException(nameof(context));
      }
      context.Services.AddSingleton‹ | YotpoReviewsService,
      YotpoReviewsService > ();
      context.Services.AddSingleton < |YotpoReviewsSettings,
      YotpoSettings > ();
    }
  }
}

Above example uses Dependency Injection through the ConfigurationContainer method. Ideally YotpoReviewsService should contain implementation code and YotpoSettings should contain Yotpo settings related information, refer below code snippet.

namespace Reviews {
  internal class YotpoSettings: IYotpoReviewsSettings {
    private readonly IAppSettingsDictionary _appSettings;
    public YotpoSettings(IAppSettingsDictionary appSettings) {
      _appSettings = appSettings;
    }
    public string BaseUrl => _appSettings.GetValue("yotpo_BaseUrl");

    public string AppKey => _appSettings.GetSiteSpecificValue("yotpo_AppKey");

    public string Secret => _appSettings.GetSiteSpecificValue("yotpo_Secret");
  }
  public interface IYotpoReviewsSettings {
    string BaseUrl {
      get;
    }
    string AppKey {
      get;
    }
  }
}

• Optimizely Scheduled Jobs

  • A scheduled job is a service performing a task (job) at a given time interval or an administrator can start it manually. By default, Optimizely platform with Optimizely CMS and Optimizely Commerce includes several scheduled jobs. You can develop customized scheduled jobs for specific website purposes. Creation of jobs are provided in details in mentioned articles https://docs.developers.optimizely.com/content-cloud/v11.0.0-content-cloud/docs/scheduled-jobs  https://docs.developers.optimizely.com/commerce/v13.0.0-commerce-cloud/docs/scheduled-jobs 

• For Yotpo Review, Jobs can be created for syncing between Yotpo Review and Optimizely. One of the use cases can be the synchronization process of Orders. Below are the list of api’s that can be useful for performing the syncing process through jobs:

  • https://core-api.yotpo.com/v1.0/reference/introduction-to-purchases

  • https://core-api.yotpo.com/v1.0/reference/introduction-to-products

  • https://core-api.yotpo.com/v1.0/reference/introduction-to-product-grouping

To conclude the article in a few words:

• Optimizely (CMS & Commerce) site(s) can easily make use of Yotpo Review.

• With “Yotpo-Review” front-end component’s and API’s, your Optimizely website can implement Richer benefits of the review functionality.