Experian QAS Verification Module for Magento

Transcription

1 Verification Module for Magento

2 1. Introduction This document is intended as a technical resource for the installation, setup and use of the QAS Verification Module for Magento. QAS is a leading provider of address data quality software and services. The QAS software suites of products are designed for Real-time verification. 2. Overview Magento is an open source e-commerce CMS that uses a LAMP (Linux, Apache, MySQL, PHP) architecture. As an open source platform, the modifications one could make to their website are limitless. With this in mind the integration was developed to incorporate as close to core Magento API functionality as possible. This integration expects that customizations made by administrators to Magento will be to the front-end (end-user display), therefore it does not depend on the layout of these forms. This can result in a few display peculiarities as described within. 3. Requirements Magento Community Edition v1.7+ QAS Validation Secure Token Access to the validation service via an internet connection Magento QAS Verification Module from Magento Connect Magento Administrative Privileges. 4. QAS Touch Points 4.1 Account Information The Account information page is located in the My Account section on a Magento website.

3 Account Information Touch Point 4.2 Registration on Checkout and Guest Checkout The Registration on Checkout page and Guest Checkout is located in the Checkout Method section on a Checkout Page of Magento website. It is available only for a not logged in customer.

4 Registration on Checkout Touch Point 4.3 Registration Page, Contact Us and to Friend The Registration page is available on magento website header link for a not logged in customer.

5 Registration Page Touch Point Contact Us page is available to contact with the magento website customer care. Contact Us Page Touch Point to a friend is available on magento to send to friend.

6 to Friend Touch Point 4.4 Sign up for Newsletter The Sign up for newsletter is located at the footer section of every page on a default Magento website. 5. Validation Results When user enters an address, a request is sent to QAS Validation service. QAS Validation service quickly and accurately identifies whether or not an address is valid and deliverable.

7 Message for Illegitimate Address This service also offers suggestions for a correct address enabling users to select more accurate address. Message for Illegitimate Address with suggestion

8 Valid Address 6. Installation 6.1 Implementation Steps Prior to install be sure you have read the requirements in Part Install the QAS Verification Module from Magento Connect 2. After the installation is complete, browse to your Magento homepage in order to complete the module install 3. You should now have a General and Frontend section in your Admin Panel under System>Configurations>QAS Verification 4. Enter your QAS License key in the Secure Token field 5. Select the Touch Points you would like the validation to function on. By default all Touch Points are selected in the multi-select Touch Points field 6. Determine whether you want to Allow Invalid To Be Accepted. Further information on this setting is available in the Configuration section 7. QAS verification is now enabled. You can test this by entering address in the field of the touch point pages 6.2 Manual Installation

9 QAS recommends installing via Magento Connect rather than manually for a simpler implementation. Prior to install be sure that you have access to the QAS on Demand service via an internet connection. 1. Obtain a copy of the QAS module 2. Copy files into the appropriate folder structure within your Magento Website (ie app/code/community/qas from the downloaded package should be placed in /app/code/community/ in your instance of Magento) 3. After all copying is complete browse to your Magento homepage in order to complete the module install 4. You should now have a General and Frontend section in your Admin Panel under System>Configurations>QAS Verification 5. Enter your QAS License key in the Secure Token field 6. Select the Touch Points you would like the validation to function on. By default all Touch Points are selected in the multi-select Touch Points field. 7. Determine whether you want to Allow Invalid To Be Accepted. Further information on this setting is available in the Configuration section 8. QAS verification should now be enabled. You can test this by entering Id in the field of the touch point pages. 6.3 Obtaining a QAS Secure Token The QAS Verification secure token will be ed to the chosen contact when you purchase the service or request an evaluation. The Secure token consists of alphanumeric characters, do take care while inserting the secure token into Magento. 7. Configuration All configuration is handled in the Magento Admin Panel. The QAS Configuration is located in System -> Configuration -> QAS Verification. 7.1 Definition of Settings URL Experian QAS Validation service URL by default is populated in the configuration Secure Token This is for authorisation purpose to access the services of QAS. Contact your QAS sales representative for yours Touch Points These are the Touch Points QAS Verification has been configured to work on. To select or remove simply hold Ctrl and select/deselect the Touch Points you wish QAS to exist on Allow Invalid to Be Accepted

10 If the Allow Invalid To Be Accepted field is set to No then when the QAS service deems an address to be invalid and the user submits the form with the address, an error is thrown and the user is not allowed to continue until the address is valid. If the Allow Invalid To Be Accepted field is set to Yes then when the QAS service deems an address to be invalid and the user submits the form with the address, the user is able to continue through to the next step even with an invalid . This ensures that the service does not interrupt the user experience. Popup on Invalid submission Maximum No. Of GET Request This is to limit the number of GET request to be sent to QAS server. When user enters an address on frontend a request goes to QAS sever for validation. This request may contain multiple GET requests until response is not obtained.

11 Maximum 5 requests are Permissible. More than 5 requests may affect the performance on frontend. If zero is entered it will set to 1. Note: If no response is not received after sending maximum no. of GET request, in that scenario it will behave as default Magento functionality, i.e. it will only validate the sting and will no more validate the domain and status (that the is deliverable or not). 8. Technical Information 8.1 Components The QAS module has the following components: Controllers: The QAS Module doesn t override any core controller functionality. Models: The Model contains one file having function to send curl request for verifying using QAS service URL. Frontend: This module has two template files located in the path: app/design/frontend/base/default/template/qas, 1 initializes the Authenticating variable on page load and other calls the JavaScript functions. Database Tables: The QAS Module doesn t create any data base table on installation. 9. Unsupported Features & Known Issues 1. In newsletter no or sign is displayed on valid or invalid 2. The extension is only compatible with One Page Checkout 3. The validation result may contains different statuses for different addresses (e.g. undeliverable, illegitimate etc) 4. Suggestions will not be shown for every invalid address. 5. If no response is received from QAS Validation services, in that scenario it will behave as default Magento functionality, i.e. it will only validate the sting and will no more validate the domain and status (that the is deliverable or not).