TABLE OF CONTENTS

Introduction


The plugin is designed to trigger feedback requests to be sent from Feefo on your behalf to all of your customers that have ‘completed’ a transaction. These reviews, and accompanying star ratings, are then automatically published and displayed on both your website and your very own Feefo Merchant Page. 

Order statuses


Magento 2.x typically has the following default order statuses. These can be customised, however, so each merchant’s setup may differ slightly from the order statuses listed below: 


  • Suspected Fraud 
  • Processing 
  • Pending Payment 
  • Payment Review 
  • Pending 
  • On Hold 
  • Complete 
  • Closed 
  • Cancelled 

For the Magento 2.x plugin to work, you must not customise the ‘Complete’ order status. Feefo will only retrieve and process feedback requests for orders once they have reached the ‘Complete’ status. 


What integrations does the Magento 2.x plugin support?


The Magento 2.x plugin supports four methods of integration: 


  1. A service reviews widget that floats above the web page and is visible at all times. The colour, size and position of this widget are customisable from the Feefo Hub under 'Marketing’ > ‘Slide-out Reviews Tab’. 
  2. A product star rating widget that displays the star rating for a specific product and can be placed next to ‘Buy now’, ‘Add to basket’ and other key call-to-action buttons to encourage conversion.  
  3. A product reviews widget located towards the bottom of the product page and displays only those reviews left for this specific product.  
  4. A product category star rating widget that allows consumers to easily compare the ratings of various products within the same category.


How to install the Magento 2.x plugin


First, check that the URL on your Feefo Hub account matches the website you're installing the plugin on. To do this, head to Settings > Brand Profile, and find the 'Website Forwarding URL' then ensure that this is an exact match e.g., there should be no '/' at the end of the URL. If you’re installing the plugin on a URL which isn’t on your contract, please let us know before doing so. Then follow these simple steps to get your Feefo reviews up and running for your Magento2.x site: 


Open your terminal window and change the current directory to your Magento 2.x installation directory 

Create a directory app/code/Feefo/Reviews/ and copy the module files to it 

mkdir –p app/code/Feefo/Reviews


Ensure that you have permissions to execute bin/magento file: 

php bin/magento


Enable the Feefo_Reviews module: 

php bin/magento module:enable Feefo_Reviews --clear-static-content


Execute the module’s installation scripts: 

php bin/magento setup:upgrade


Compile the module: 

php bin/magento setup:di:compile


Deploy the static content: 

php bin/magento setup:static-content:deploy


Flush the Magento 2.x cache: 

php bin/magento cache:flush


Login to the admin panel of your Magento 2.x instance and you should now see a 'Feefo Ratings & Reviews' menu option under the 'Marketing' tab:  

  1. Click on ‘Feefo Ratings & Reviews’ to start the module installation process. If you have multiple stores set up within your instance you will be asked to select which store you wish to add Feefo Ratings & Reviews to 
  2. You will be presented with a registration form if you are a new customer, or a login page if you already have a Feefo account for the website domain you are setting up 
  3. Follow the step-by-step guide through the configuration of your feedback request process until installation is successfully complete  
  4. You can further configure the module post installation by selecting the ‘Marketing’ > ‘Feefo Ratings & Reviews’ tab, where you can: 
  5. Enable/disable all methods of review integration 
  6. Customise the placement of your product page and category level review integration 
  7. Enable/disable the native Magento reviews system

 

For security reasons, we recommend that you whitelist the following IP addresses:


·       194.73.84.3  

·       35.197.217.47  

·       35.197.212.84  

·       35.189.112.9  


To check that the plugin installation was successful, within the Feefo Hub first just click on your name in the top right corner and check that your merchant identifier is the same as before to ensure that it was installed on the intended account. Then if you head to Sales > Data Sources, you should see the name of the plugin you just installed listed here. If you have any questions about the installation, you notice your merchant identifier has changed, or you’d like for us to check that the plugin installation was successful, please just get in touch.


How to uninstall the Magento 2.x plugin 


Follow these steps to disable the Feefo plugin on your Magento 2.x site.  


  1. Within the admin panel of your Magento 2.x instance select ‘Stores’ > ‘Configuration’ 
  2. Select the appropriate Store View that you wish to uninstall the plugin for 
  3. Select ‘Catalogue’ > ‘Feefo Reviews’ 
  4. Click ‘Uninstall Plugin Data’


A confirmation message will be shown when the plugin has been successfully uninstalled  


To completely remove the plugin from your Magento 2.x instance: 


Open your terminal window and change the current directory to your Magento 2.x installation directory 

Make sure that you have permissions to execute bin/Magento file: 

php bin/magento


Disable the Feefo_Reviews module: 

php bin/magento module:disable Feefo_Reviews --clear-static-content


Compile the required classes of the module: 

php bin/magento setup:di:compile


Delete the app/code/Feefo directory 


Delete the admin user with username 'feefo' 


Delete records with paths "feefo/service/access_key", "feefo/service/user_id", "feefo/service/plugin_id", "feefo/widget/settings", "feefo/widget/snippets" from the "setup_module" and "core_config_data" table 


DELETE FROM setup_module WHERE module LIKE ‘%feefo%’ 


DELETE FROM core_config_data WHERE path LIKE ‘%feefo%’  


Troubleshooting 


If at any point you see the 'Something went wrong' page, please follow these steps to help you identify the cause of your issue: 


Open your terminal window and change the current directory to your Magento 2.x installation directory 

Open a log file with debugging information 

vim var/log/debug.log

Near the end of the file, you should find a log of the issue. If you are not able to resolve the issue based on the information in the log, please send a copy of it to our Technical Support Team for further assistance via support@feefo.com