Styla SEO Enhancements Shopware Module (v4.2.7)

Last updated: 02.08.2017

Contributors: Sebastian Sachtleben, Christian Korndoerfer, Roberto Solís, Antonio Cosentino

Styla Connect is a module to connect your Shopware 4 Store with Styla. For our Shopware 5 plugin check this https://github.com/styladev/shopware5

The first diagram on this page should provide you an overview of what the plugin does and how it exchanges data with Styla.

Requirements

Shopware version 4.3.1 or later

There have been issues with PHP 7 in the past. Should you have some, please report back to us. The plugin works best on PHP 5.6.

Installation How-to

• Place the StylaSEO folder at the following location of your Shopware installaton: engine/Shopware/Plugins/Local/Frontend
• Once the code is in place, access your Shopware administration page. The Styla SEO Enhancements Shopware module can be configured and activated under Configuration -> Plugin Manager -> Local Extensions.
• Click on the Pencil (edit) icon to edit the plugin settings:
  • Styla Magazine ID: Your Styla username which is provided to you by your Styla account manager.
  • Styla SEO Server URL (default: https://seoapi.styla.com): Server that provides SEO information for your magazine content. (IMPORTANT: Do not modify this unless approved by Styla)
  • Styla API Server URL (default: https://client-scripts.styla.com): Server that provided the necessary scripts and styles for your magazine. (IMPORTANT: Do not modify this unless approved by Styla)
  • Styla Base Folder (default: magazine): Path to your main magazine page. Your magazine will become available at /[Styla Base Folder] (e.g. /magazine). (IMPORTANT: Before changing, make sure to contact you account manager and provide him/her the new magazine path)
• Once all done, clear Shopware cache

If everything is set up correctly the following pages will be accessible:

- **Main magazine:** http://[yourwebsite.com]/[Styla Base Folder]/
- **Tag:** http://[yourwebsite.com]/[Styla Base Folder]/tag/[tagname]
- **Category:** http://[yourwebsite.com]/[Styla Base Folder]/user/[Styla Magazine ID]/category/[category]
- **Story:** http://[yourwebsite.com]/[Styla Base Folder]/story/[storyname]
- **Search:** http://[yourwebsite.com]/[Styla Base Folder]/search/[searchterm]

Please do not create any subpages in your CMS or directories for your magazine. The plugin itself will take care of setting up the /magazine/ (or any other) page on which the magazine will appear and of the routing as well.

SEO Content from Styla's SEO API

The module uses data from Styla's SEO API to:

• generate tags like: meta tags including <title>, canonical link, og:tags, static content inserted into , robots instructions
• insert these tags accordingly into HTML of the template the page with Styla content uses

This is done to provide search engine bots with data to crawl and index all Styal URLs, which are in fact a Single-Page-Application.

Once you install and configure the module, please open source of the page on which your Styla content is embedded and check if none of the tags mentioned below are duplicated. In case robotsor link rel="canonical" or any other are in the HTML twice, make sure to remove the original ones coming from your default template. Otherwise search engine bots might not be able to crawl all the Styla content or crawl it incorrectly.

You can finde more information on the SEO API on this page

Update the Plugin

• Place the StylaSEO folder at the following location of your Shopware installation: engine/Shopware/Plugins/Local/Frontend
• Once the code is in place, access your Shopware administration page. The Styla Magazine Plugin can be configured and activated under Configuration -> Plugin Manager -> Local Extensions.
• Click on the Update icon in the "actions" column of the plugin.
• Click Configuration -> Cache/performance -> clear shop cache

Setup Process

The process of setting up your Content Hub(s) usually goes as follows:

1. Install and configure the plugin on your stage using Content Hub ID(s) shared by Styla
2. Share the stage URL, credentials with Styla
3. Styla integrates product data from endpoints provided by the plugin, test your stage Content Hub and asks additional questions, if needed
4. Install and configure the plugin on production, without linking to the Content Hub(s) there and, again, share the URL with Styla
5. Make sure your content is ready to go live
6. Styla conducts final User Acceptance Tests before the go-live
7. Go-live (you link to the Content Hub embedded on your production)