Skip to content
Gregory edited this page Aug 26, 2014 · 1 revision

Overview

The Arqspin Magento extension enables users to embed spins into their product pages. This will enrich the customer experience and allow them to view 360 degree product previews.

Support

For support with your Arqspin account, please visit Arqspin Support . This software will not work unless you have a valid Arqspin account. To obtain the required account information, please contact your Arqspin representative.

Prerequisites

Versions

The latest version is 1.1.2 (August 25, 2014). It can be obtained via Github and in the future, Magento Connect. The extension supports all current versions of Magento Community after 1.2 and current versions of Magento Enterprise after 1.5.

Getting Started

Installation

Configuration

Within the Magento Admin, browse to System > Configuration > Catalog/Arqspin.

  • Account Username: Enter your Arqspin username.
  • Auto load: Automatically load the spin on the page to prepare it for spinning.
  • Auto rotate: Automatically start rotating the spin once it's loaded.
  • Auto stop: Automatically stop rotating the spin once it's completed a full rotation.
  • Embed type: Technology used to embed the spin.
  • IFrame
  • Flash
  • Display type: Location for the spin.
  • Gallery: If a product has a spin, thumbnail is shown first or last in the list of additional images; clicking on the thumbnail brings up the spin in a popup.
  • Primary: Replace the primary image if a product has a spin set on it; user can interact with spin on the product page.
  • Separate: If a product has a spin, spin is embedded below the product image gallery; user can interact with spin on the product page.
  • Gallery position: If Gallery chosen above, this determines where in the list of additional images the thumbnail for the spin is shown.
  • Thumbnail URL: URL where spin thumbnails are hosted. Can be changed for a more consistent brand experience, but default can be used.

Product Setup

Within the Magento Admin, Catalog > Manage Products, and select a product you would like to add a spin to. On the Manage Product screen, under the Product Information navigation, you will find Arqspins at the bottom. Select that option, on the next page will load all the spins associated with your account. If you have added a custom title to your spins, you may search for it in the text box. You could also go through the entire list to select your specific spin. Once a spin has been selected, save the product. Alternatively, if you know your spin id, you may put that id in the General section of the Manage Product, under 'Arqspin Id'.

Technical Details

The extension extends the Mage_Catalog_Block_Product_View_Media class and to make a new copy of getGalleryImages().

Important Notes

The extension currently relies on a hardcoded API URL. If this is something that changes often, there will need to be a configuration option added. This can either be a text input like the 'Thumbnail URL' config, or a dropdown with a set of URLs. If Mage_Catalog_Block_Product_View_Media is extended in other parts of the Magento install, keep in mind function overloads and class collision risks.

Common Problems

None to currently note. Pending more widespread usage. Please report any issues through Github Issues