ONESCAN PAYMENT EXTENSION MANUAL
Contents Introduction...2 Key Benefits...2 Give your customers a quick simple and secure interface with Onescan...2 Installation...3 Note about Shipping Methods...6 Notes on Azure Magento Web App...6 Next Steps...7 Configuration Panel...8 Enabled...9 Onescan Account Key...9 Onescan Secret...9 Onescan Server URL...9 Basket Logo URL...9 Register Success Message...9 Skip Confirmation Email...9 Email Exists Message...9 Unknown Region Message...9 Cannot Deliver Message...9 Login Success Message...9 Customer Deleted Message... 10 Email Not Confirmed Message... 10 Shopping Basket Name... 10 Show Onescan on cart page... 10 Show Onescan on mini cart... 10 Show now accepting Onescan... 10 -- 1 --
Introduction The Onescan Payment Extension brings speed and security to the Magento platform, allowing customers to register, login or even purchase, with just one scan from their mobile phone. Key Benefits Free to download extension for users of Magento Community Edition Simple configuration and set up Customers never need fill in a form again Registration in just one simple scan Returning user can login with just Onescan Purchases in just, you guessed it, Onescan Why you should integrate Onescan into your Magento platform Take your customers from looking to buying in less than 10 seconds. Onescan is the innovative mobile app bought to you by Ensygnia. Once a consumer has set up their Onescan mobile app, they will never have to fill in a form again. Regardless if a customer is new to the site or returning, with just 'Onescan', your customers can register or login and complete a payment in seconds. We tear down the barriers that turn customers off and make sure nothing stops them interacting with you. Give your customers a quick simple and secure interface with Onescan No usernames and passwords to remember, no security checks to pass, or tiresome forms to fill. All while improving the security of your site. There is no username and password database to be hacked. What doesn't exist can't be stolen. And the burden of dealing with sensitive financial information if lifted. Payments are confirmed by a tokenised system: at no point do the details need to be shared. Thanks to Onescan, mobile phones become a secure proof of identity. Online, all customers have to do to login, register or even purchase an item is complete one simple scan. We take all the hassle out of online shopping and tear down the barriers between you and your customers. -- 2 --
Installation The Onescan Payment Extension is available on Magento Connect at http://www.magentocommerce.com/magento-connect/onescan-payment-plugin.html and works with the community edition of Magento, version 1.7 and greater. 1. Log in to your Magento Connect account at http://www.magentocommerce.com/magentoconnect/. 2. Search for Onescan Payment Extension or go directly to http://www.magentocommerce.com/magento-connect/onescan-payment-plugin.html. 3. From the Onescan Payment Extension page on Magento Connect, click on the Install Now button. 4. Agree to the extension license agreement and click on Get extension key. 5. Click the Select Key button to select the entire key and then copy it to the clipboard by pressing CTRL-C on the keyboard or right-clicking on the key and selecting Copy from the menu that pops up. -- 3 --
6. From the admin panel in your Magento installation, select System / Magento Connect / Magento Connect Manager. You will be asked to provide your login credentials again; these are the credentials you use to access your Magento installation s admin panel. -- 4 --
7. Under the Install New Extensions heading, paste the extension key from step 5 into the box labelled Paste extension key to install: by pressing CTRL-V on the keyboard or right clicking on the box and selecting Paste from the menu that pops up. This will download the extension, which may take a short while. 8. Click the Proceed button at the bottom of the list of extensions. 9. Wait for the installation to complete. 10. To access the Onescan Payment Extension configuration, you may need to log out of your Magento installation s admin and log back in again. You may also need to clear the cache by going System / Cache Management for the Onescan Payment Extension to work correctly. -- 5 --
Note about Shipping Methods When more than one shipping method is available, the text that appears on the Onescanner s device for each of the valid shipping methods that they can choose from comes from the Method Name field in the Shipping Methods configuration panel in the Magento administration. Please ensure that for each shipping method that is enabled, this field contains a meaningful value. To change the Method Name field in the Magento administration panel, go to System/Configuration and then select Shipping Methods from the left side menu. Notes on Azure Magento Web App If your Magento installation is the Azure Magento Web App, you will need to take some additional steps to ensure that your site can communicate with Onescan via SSL. The curl implementation that underlies PHP and Magento does not come with the CA root certificate bundle already installed, so you will need to do this yourself. 1. Go to your website and under Application Settings, there is a section entitled App Settings. Add a new entry with the key of PHP_INI_SCAN_DIR and a value of D:\home\site\ini (without quotes). 2. Using FTP or Kudu, create a folder called ini under the D:\home\site folder and in the new folder add a file called settings.ini with the following contents:- curl.cainfo=d:\home\site\ini\cacert.pem 3. In the same folder, add the file at http://curl.haxx.se/ca/cacert.pem. -- 6 --
Next Steps If you haven t already done so, you will need to register for Onescan with Ensygnia at https://portal.ensygnia.net/. Once done, you will be given your Onescan Account Key and Onescan Secret for your sandbox account for use in your testing environment. Please note that your sandbox account is a free account which enables you to test the Onescan Payment Extension on your Magento installation and that no payments are possible with the Sandbox account. It is strongly advised that you do not deploy your sandbox account in a live trading environment; for this you will need a live account. Your Onescan Account Key and Onescan Secret will need to be entered into the Onescan Payment Extension configuration panel before any Onescan padlocks can be shown on your Magento installation s front end. Once you are happy with the way your sandbox account integrates with your Magento installation, you can log in to the portal at https://portal.ensygnia.net/ and apply for a live account. Once done, you will be given your Onescan Account Key and Onescan Secret for your live account for use in your live trading environment. -- 7 --
Configuration Panel To access the configuration panel, go to the admin of your Magento installation and select System / Configuration, then in the menu on the left, in the Sales section, click on Onescan. -- 8 --
Enabled Select Yes to enable the Onescan Payment Extension or No to disable it. If disabled, no Onescan padlocks will be displayed in your Magento installation. The default value is Yes. Onescan Account Key This is where you enter the Onescan Account Key provided to you when you signed up for Onescan at https://portal.ensygnia.net/. The Onescan Account Key is case sensitive and no padlocks can be displayed correctly without a valid key. Onescan Secret This is where you enter the Onescan Secret provided to you when you signed up for Onescan at https://portal.ensygnia.net/. The Onescan Account Key is case sensitive and no padlocks can be displayed correctly without a valid secret. Onescan Server URL This is the URL used to access the Onescan service and you should not edit this unless instructed to do so by Ensygnia. The default value is https://liveservice.ensygnia.net/api/partnergateway/1/. Basket Logo URL This is the URL of the image that will appear on the Onescanner s device to represent their shopping basket. This should be a standard image in.jpg.png or.gif format. The default value is the Ensygnia logo. Register Success Message This is the message that is displayed to somebody that has used Onescan to register on your Magento installation. The default value is You have successfully registered using Onescan. We have sent you an email with your login details should you ever need to log in "manually". Skip Confirmation Email If your Magento installation is set up to require new registrations to confirm their email address, you have the option to skip the confirmation email for those that register using Onescan by setting this field to Yes. If you do not require email confirmation for manual registrations, this field has no effect. The default value is Yes. Email Exists Message This is the message that is displayed if somebody attempts to use Onescan register with an email address that is already associated with an existing account in your Magento installation. The default value is Email address already registered, please log in using Onescan. Unknown Region Message If the Onescanner chooses delivery to a country in which Magento requires state/region, this is the message that will appear on the Onescanner s device if Magento does not recognise the state/region that was supplied. To set which countries require state/region to be supplied, in the Magento System/Configuration menu under General/General, click on States options. The default value is The county/state/region you supplied is not known, please edit your address. Cannot Deliver Message This is the message displayed on the Onescanner s device if Magento cannot deliver to the address that was supplied. This is usually because they have asked for delivery to a country that you do not cover. The default value is We cannot deliver your order to the address you supplied. Login Success Message The message that is displayed after a successful login using Onescan. The default value is You have successfully logged in using Onescan. -- 9 --
Customer Deleted Message Onescan uses a tokenised login system in which a unique token associated with a Onescanner is linked to the customer account on your Magento installation. If you were to delete a customer s account in the Magento admin panel, the login token would then be associated with an account that no longer exists. This is the message that is displayed if such a customer subsequently attempts to login using Onescan. The default value is We cannot find your account on our system. Please use Onescan to create a new account. Email Not Confirmed Message If your Magento installation requires email confirmation in order to register and you have Skip Email Confirmation set to No, this is the message that is displayed if a login attempt is made with Onescan before the email address has been confirmed. Use %s to replace the URL used to resend the confirmation email. The default value is This account is not confirmed. <a href="%s">click here</a> to resend confirmation email. Shopping Basket Name The text that will appear on the device and in the confirmation emails to describe the shopping basket. The default value is Shopping Basket. Show Onescan on cart page Set this to Yes to show the Onescan padlock on the main shopping cart page. The default value is Yes. Show Onescan on mini cart Set this to Yes to show the Onescan padlock on the mini cart. The default value is Yes. Show now accepting Onescan Set this to Yes to show the Now accepting Onescan message on your Magento installation. The default value is Yes. -- 10 --