Magento Integration scripts

Transcription

Magento Integration scripts
 Magento Integration script for Poq Studio
This script lets Poq Studio get product information from the website, and post
orders back into the dekstop site's shopping cart.
We have tested it on Magento 1.7 community and on enterprise, and it should
be fairly easy to get up and running.
If you have a staging environment, we recommend installing the module there
and testing it before putting it on a live site.
If you prefer to let Poq Studio install the script for you, you must send over the
FTP details of your staging or live server, and login details for Magento admin.
Please contact Poq Studio if you have any problems with the script, or if you
see any improvements that should be made to the code or documentation.
Module Installation instructions
-------------------------------The zip archive contains folders that match your Magento installation. Here
are the instructions for how to enable the module:
1. Copy the /app/code/local/Poq folder from the zip archive into
/app/code/local/
2. Copy the /app/etc/modules/Poq_Integration.xml file from the zip archive into
/app/etc/modules/
3. Log into Magento admin, go to System - Cache Management, click Flush
Magento Cache
4. Go to System - Configuration - Advanced in Magento admin, you should
see Poq_Integration as a module in the list.
5. Open [yourdomainname]/poq/index/ and you should see it output simply
"POQ" to confirm that the module is installed successfully.
Enable mobile CSS on the checkout
--------------------------------Add the mobile CSS head code:
Create the file /app/design/frontend/ ...
/default/template/poq/poq_mobile_style.phtml
Poq Studio | Company No. 7791197 |
Registered Office: 1 Sekforde Street,
London EC1R 0BE www.poqstudio.com
Add the following code to it:
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="stylesheet" media="screen and (max-width: 767px)"
href="//shop.poqstudio.com/css/mobile.css" />
<link rel="stylesheet" type="text/css" media="screen and (min-width: 768px)
and (max-width: 979px)" href="//shop.poqstudio.com/css/tablet.css" />
Reference the mobile CSS:
The file app\design\frontend\ ... \default\layout\checkout.xml has two sections
called checkout_onepage_index and checkout_cart_index . In it is a section
called <reference name="head">
Please add this code at the end of the reference block to activate the mobile
CSS:
<block type="checkout/cart" name="poq.checkout"
template="poq/poq_mobile_style.phtml" />
If there's no reference to head there, please add the following:
<reference name="head">
<block type="checkout/cart" name="poq.checkout"
template="poq/poq_mobile_style.phtml" />
</reference>.
Module Configuration
-------------------The file /app/code/local/Poq/Integration/controllers/IndexController.php has a
number of configuration settings in the cartAction() method:
$next_url = '/checkout/cart/';
//After the product are added, redirect to this
url.
$require_https = false;
//SSL-encrypted requests cannot be read by
anyone else, and will not be stored in history etc.
$require_signed_request = false; //If enabled, will require the request to be
signed, we can verify that the URL has not been tampered with.
$signed_request_secret = ''; //Get this configuration value from Poq Studio
$limit_referer = false;
//Enable this to require the request to come from
our trusted source.
$safe_referer_list = array("poqstudio.com", "cloudapp.net"); //add mobile
website domains here if limit_referer is set to true, leave cloudapp.net and
poqstudio.com.
$tracking_code = "utm_source=mobile&utm_campaign=poq"; //If set, will be
added to the checkout page URL.
Poq Studio | Company No. 7791197 |
Registered Office: 1 Sekforde Street,
London EC1R 0BE www.poqstudio.com
Basic configuration:
1. If your website uses HTTPS, you can change $require_https to true.
2. If desired, enable $limit_referer and add your m. domain name to
$safe_referer_list
3. You can change where the customer lands after the shopper transfers the
cart. Common options are /checkout/cart/ or /checkout/onepage/. if you have
a custom checkout page you can eneter its URL here.
4. You can add a custom campaign tracking or custom analytics to the
$tracking_code variable. The contents of this variable will be appended to the
redirect URL.
5. If you require the highest level of security for the shoping cart transfer, you
can get a password from Poq Studio to securely sign each request. Put this
password in the $signed_request_secret variable. Then set
$require_signed_request to true to enable the additional security.
Poq Studio | Company No. 7791197 |
Registered Office: 1 Sekforde Street,
London EC1R 0BE www.poqstudio.com