Skip to content

Commit b0fc7a9

Browse files
author
Benoît Xylo
committed
Draft of the documentation for version 1.7.2
Changelog for version 1.7.2
1 parent 936a987 commit b0fc7a9

10 files changed

Lines changed: 131 additions & 80 deletions

configuration.rst

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@ Configuration
44
=============
55
After the successful installation you can proceed to the configuration. In Magento admin go to :menuselection:`creativestyle --> Login and Pay with Amazon --> Settings` (or :menuselection:`System --> Configuration --> Amazon Payments` tab).
66

7-
.. image:: /images/1.6.4/configuration_screenshot_1.png
7+
.. image:: /images/1.7.2/configuration_screenshot_1.png
88

99
Available options are grouped in following sections:
1010

11-
.. image:: /images/1.6.4/configuration_screenshot_10.png
11+
.. image:: /images/1.7.2/configuration_screenshot_10.png
1212

1313
Amazon Payments Account
1414
-----------------------
1515
In this section you can define your Amazon Payments seller account credentials.
1616

17-
.. image:: /images/1.6.4/configuration_screenshot_2.png
17+
.. image:: /images/1.7.2/configuration_screenshot_2.png
1818

1919
.. _configuration-credentials:
2020

2121
`Merchant ID, Access Key ID, Secret Access Key`
2222
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23-
Fill out those fields with your Amazon Payments seller credentials. You can find them in the Amazon Seller Central, see: :ref:`prerequisites-obtaining-merchant-id` and :ref:`prerequisites-obtaining-access-and-secret-key`.
23+
Fill out those fields with your Amazon Payments seller credentials. You can find them in the Amazon Seller Central, see: :ref:`prerequisites-where-to-find-the-required-credentials`.
2424

2525
.. _configuration-marketplace:
2626

@@ -42,7 +42,7 @@ General Settings
4242
----------------
4343
In this section you can enable or disable the **Pay with Amazon** service and define basic settings of the extension.
4444

45-
.. image:: /images/1.6.4/configuration_screenshot_3.png
45+
.. image:: /images/1.7.2/configuration_screenshot_3.png
4646

4747
.. _configuration-enable-pay:
4848

@@ -115,7 +115,7 @@ Login with Amazon
115115
-----------------
116116
In this section you can configure **Login with Amazon** service.
117117

118-
.. image:: /images/1.6.4/configuration_screenshot_7.png
118+
.. image:: /images/1.7.2/configuration_screenshot_7.png
119119

120120
.. _configuration-enable-login:
121121

@@ -125,20 +125,24 @@ By switching this option you can enable or disable **Login with Amazon** feature
125125

126126
`Client ID`
127127
~~~~~~~~~~~
128-
The Client ID identifies your website for **Login with Amazon** service. Please refer to the :ref:`Obtaining Client ID <prerequisites-obtaining-client_id>` section to find out how to get the value of your Client ID.
128+
The Client ID identifies your website for **Login with Amazon** service. Please refer to :ref:`prerequisites-where-to-find-the-required-credentials` section to find out how to get the value of your Client ID.
129+
130+
`Display Language`
131+
~~~~~~~~~~~~~~~~~~
132+
In this option you can select a language which will be used for displaying all elements (froms, widgets) generated by Amazon Payments. Selected language will be also used to localize emails sent by Amazon Payments to the customer after purchase. This setting applies also to **Pay with Amazon** as long as **Login with Amazon** is enabled.
129133

130134
`Authentication Experience`
131135
~~~~~~~~~~~~~~~~~~~~~~~~~~~
132136
Select the method the authentication will be processed. By default `Pop-up` is used, meaning that after pressing `Pay` or `Login with Amazon` button, new window with Amazon login form opens, this requires the page you are placing the buttons on to be SSL-secured though. Choosing `Redirect` experience your customers will be redirected to Amazon login form in the current window after pressing `Pay` or `Login with Amazon` button. For the `Redirect` experience it is required to set `Allowed Return URLs` in the `Login with Amazon` section in your Seller Central.
133137

134-
.. warning:: Be aware that `Pop-up` authentication experience used by default requires the page the button is placed on to be in the SSL mode. This requirement is fulfilled by switching the cart page into SSL on the fly. This may lead to the unexpected results, especially if you are using some non-default Magento extensions (eg. AJAX-based adding to cart). It is always advised to test the extension in the staging environment prior to the production deployment.
138+
.. warning:: Be aware that `Pop-up` authentication experience used by default requires the page, the button is placed on, to be in the SSL mode. This requirement is fulfilled by switching the cart page into SSL on the fly. This may lead to the unexpected results, especially if you are using some non-default Magento extensions (eg. AJAX-based adding to cart). It is always advised to test the extension in the staging environment prior to the production deployment.
135139

136140
----
137141

138142
Email Options
139143
-------------
140144

141-
.. image:: /images/1.6.4/configuration_screenshot_4.png
145+
.. image:: /images/1.7.2/configuration_screenshot_4.png
142146

143147
.. _configuration-order-confirmation:
144148

@@ -166,7 +170,7 @@ Common Appearance Settings
166170
--------------------------
167171
In this section you can set size (width and height) of Amazon widgets used in the checkout process.
168172

169-
.. image:: /images/1.6.4/configuration_screenshot_5.png
173+
.. image:: /images/1.7.2/configuration_screenshot_5.png
170174

171175
.. _configuration-use-responsive-widgets:
172176

@@ -190,7 +194,7 @@ Appearance Settings for Login and Pay with Amazon
190194
-------------------------------------------------
191195
These settings apply to the design (type, size and color) of the buttons, both `Pay with Amazon` and `Login with Amazon`, when :ref:`configuration-enable-login` option is set to `Yes`, therefore they become irrelevant if you don't use **Login with Amazon** service, you may be interested then in :ref:`configuration-pay-appearance-settings`.
192196

193-
.. image:: /images/1.6.4/configuration_screenshot_8.png
197+
.. image:: /images/1.7.2/configuration_screenshot_8.png
194198

195199
----
196200

@@ -200,14 +204,14 @@ Appearance Settings for standalone Pay with Amazon
200204
--------------------------------------------------
201205
These settings apply to the design (size and color) of the `Pay with Amazon` button when :ref:`configuration-enable-login` option is set to `No`, therefore they become irrelevant if you use **Login with Amazon** service, :ref:`configuration-login-appearance-settings` are applied then.
202206

203-
.. image:: /images/1.6.4/configuration_screenshot_9.png
207+
.. image:: /images/1.7.2/configuration_screenshot_9.png
204208

205209
----
206210

207211
Developer options
208212
-----------------
209213

210-
.. image:: /images/1.6.4/configuration_screenshot_6.png
214+
.. image:: /images/1.7.2/configuration_screenshot_6.png
211215

212216
`Allowed IPs (comma separated)`
213217
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123 KB
Loading
155 KB
Loading
106 KB
Loading

index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Proudly provided by:
1818
installation
1919
configuration
2020
customization
21+
login
2122
workflow
2223
testing
2324
faq

installation.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,20 @@ Pre-installation steps
1313
Installation process
1414
--------------------
1515

16+
.. image:: /images/1.7.2/installation_step_1.png
17+
1618
* Go to :menuselection:`System --> Magento Connect --> Magento Connect Manager` and enter your admin credentials to get logged in.
17-
* In the `Install New Extensions` section enter **Login and Pay with Amazon** extension key obtained from `Magento Connect <http://www.magentocommerce.com/magento-connect/login-and-pay-with-amazon-advanced-payment-apis-for-europe.html>`_ and click :guilabel:`Install` button.
18-
* Installation will start and after successful install it will show a message. Optionally, you can click on :guilabel:`Refresh` button to see if **Login and Pay with Amazon** (identified as `Creativestyle_AmazonPayments`) is listed on list of the installed extensions.
19+
20+
.. image:: /images/1.7.2/installation_step_2.png
21+
22+
* In the `Install New Extensions` section enter **Login and Pay with Amazon** extension key obtained from `Magento Connect <http://www.magentocommerce.com/magento-connect/login-and-pay-with-amazon-advanced-payment-apis-for-europe.html>`_ and click `Install` button. Magento will display information about the extension you are about to install and after making sure this is the right version click `Proceed` button.
23+
24+
.. image:: /images/1.7.2/installation_step_3.png
25+
26+
* Installation will start and after successful install it will show a message. Optionally, you can click on `Refresh` button to see if **Login and Pay with Amazon** (identified as `Creativestyle_AmazonPayments`) is listed on list of the installed extensions.
27+
28+
.. image:: /images/1.7.2/installation_step_4.png
29+
1930
* Proceed to the post-installation steps.
2031

2132
Post-installation steps

login.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Login with Amazon
2+
=================
3+
**Login with Amazon** allows users to login to your shop using their Amazon user name and password. All available data needed for creating an account or placing an order in your Magento shop (including name, email address, and zip code) are fetched automatically from customer's Amazon account.
4+
5+
Requirements
6+
------------
7+
**Login with Amazon** service requires you to have a valid **Login and Pay with Amazon** account (refer to the :ref:`prerequisites-amazon-account-setup` if you don't have one yet), registered application for **Login with Amazon** service (refer to the :ref:`prerequisites-registering-application-for-login-with-amazon` if you don't have one yet) and Magento store with a valid SSL certificate installed and properly configured in your shop. By "installed and properly configured SSL certificate" it is meant that your webserver is configured to serve pages via HTTPS protocol, `Base URL` config option is set to the HTTPS-based URL and in :menuselection:`Web --> Secure` section of Magento settings.
8+
9+
`Login with Amazon` button
10+
--------------------------
11+
The `Login with Amazon` button appears in several places in the shop:
12+
13+
* on the customer login page,
14+
* on the customer registration page.
15+
16+
.. image:: /images/1.7.2/login_screenshot_1.png
17+
18+
You can also place the `Login with Amazon` button in any place you like by including following statement in the template file:
19+
20+
.. code-block:: php
21+
22+
<?php echo Mage::helper('amazonpayments')->getLoginWithAmazonButton(); ?>
23+
24+
Pressing the `Login with Amazon` button launches the Amazon authentication window, where the customer is asked for his Amazon account e-mail address and password.
25+
26+
.. image:: /images/1.7.2/order_step_2.png
27+
28+
After a successful login the customer is redirected to the user area in your shop.
29+
30+
.. note:: When the customer uses the `Login with Amazon` for the first time in your shop and account with the same e-mail address already exists in your shop, he will be asked to enter his shop password to match both shop and Amazon accounts. Moreover, if you require additional data from your customers which cannot be provided by Amazon (like date of birth or gender), the customer will be asked for those data in a dedicated form, that appears after the first use of `Login with Amazon` button.

overview.rst

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,16 @@ The extension is a pure payment solution. No item level is communicated to Amazo
99
Extension features
1010
------------------
1111

12-
* **Pay with Amazon** button in the shopping cart and in the 1st step of OnePage checkout
13-
* **Login with Amazon** button on the customer login page
12+
* `Pay with Amazon` button in the shopping cart and in the 1st step of OnePage checkout
13+
* `Login with Amazon` button on the customer login and registration page
1414
* Customization of **Login and Pay with Amazon** widgets from within Magento admin
1515
* Support for payment authorizations, captures and refunds (also partial refunds)
16+
* Support for synchronous and asynchronous authorization
1617
* Supports Amazon Instant Payment Notifications
1718
* Live & sandbox modes available
1819
* Toolbox for simulating payment states in sandbox mode
1920
* CSV-based event logger
21+
* Multilanguage, available languages: en, de, fr, es, it
2022

2123
Getting the extension
2224
---------------------
@@ -29,6 +31,34 @@ Refer to the :ref:`installation` section to get more details concerning installa
2931
Changelog
3032
---------
3133

34+
Version 1.7.2
35+
~~~~~~~~~~~~~
36+
37+
Major Highlights
38+
''''''''''''''''
39+
40+
* Implemented multilanguage feature for Login with Amazon
41+
42+
Improvements
43+
''''''''''''
44+
45+
* Implemented re-authorization after the first authorization expires
46+
* Putting order on hold for some kinds of closed authorization
47+
* Added reason code of the transaction status directly to the order comments
48+
* Added store name to SetOrderReferenceDetails call
49+
50+
Changes
51+
'''''''
52+
53+
* Updated Amazon Payments SDK library to 1.0.14
54+
55+
56+
Fixes
57+
'''''
58+
59+
* Fixed Firefox redirect experience issue
60+
* Fixed issues in the splitting full customer name helper function
61+
3262
Version 1.6.4
3363
~~~~~~~~~~~~~
3464

0 commit comments

Comments
 (0)