Skip to content

Commit

Permalink
Draft of the documentation for version 1.7.2
Browse files Browse the repository at this point in the history
Changelog for version 1.7.2
  • Loading branch information
Benoît Xylo committed Aug 12, 2015
1 parent 936a987 commit b0fc7a9
Show file tree
Hide file tree
Showing 10 changed files with 131 additions and 80 deletions.
30 changes: 17 additions & 13 deletions configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ Configuration
=============
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).

.. image:: /images/1.6.4/configuration_screenshot_1.png
.. image:: /images/1.7.2/configuration_screenshot_1.png

Available options are grouped in following sections:

.. image:: /images/1.6.4/configuration_screenshot_10.png
.. image:: /images/1.7.2/configuration_screenshot_10.png

Amazon Payments Account
-----------------------
In this section you can define your Amazon Payments seller account credentials.

.. image:: /images/1.6.4/configuration_screenshot_2.png
.. image:: /images/1.7.2/configuration_screenshot_2.png

.. _configuration-credentials:

`Merchant ID, Access Key ID, Secret Access Key`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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`.
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`.

.. _configuration-marketplace:

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

.. image:: /images/1.6.4/configuration_screenshot_3.png
.. image:: /images/1.7.2/configuration_screenshot_3.png

.. _configuration-enable-pay:

Expand Down Expand Up @@ -115,7 +115,7 @@ Login with Amazon
-----------------
In this section you can configure **Login with Amazon** service.

.. image:: /images/1.6.4/configuration_screenshot_7.png
.. image:: /images/1.7.2/configuration_screenshot_7.png

.. _configuration-enable-login:

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

`Client ID`
~~~~~~~~~~~
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.
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.

`Display Language`
~~~~~~~~~~~~~~~~~~
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.

`Authentication Experience`
~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.

.. 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.
.. 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.

----

Email Options
-------------

.. image:: /images/1.6.4/configuration_screenshot_4.png
.. image:: /images/1.7.2/configuration_screenshot_4.png

.. _configuration-order-confirmation:

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

.. image:: /images/1.6.4/configuration_screenshot_5.png
.. image:: /images/1.7.2/configuration_screenshot_5.png

.. _configuration-use-responsive-widgets:

Expand All @@ -190,7 +194,7 @@ Appearance Settings for Login and Pay with Amazon
-------------------------------------------------
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`.

.. image:: /images/1.6.4/configuration_screenshot_8.png
.. image:: /images/1.7.2/configuration_screenshot_8.png

----

Expand All @@ -200,14 +204,14 @@ Appearance Settings for standalone Pay with Amazon
--------------------------------------------------
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.

.. image:: /images/1.6.4/configuration_screenshot_9.png
.. image:: /images/1.7.2/configuration_screenshot_9.png

----

Developer options
-----------------

.. image:: /images/1.6.4/configuration_screenshot_6.png
.. image:: /images/1.7.2/configuration_screenshot_6.png

`Allowed IPs (comma separated)`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Binary file added images/1.7.2/login_screenshot_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/1.7.2/prerequisites_screenshot_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/1.7.2/prerequisites_screenshot_19.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Proudly provided by:
installation
configuration
customization
login
workflow
testing
faq
Expand Down
15 changes: 13 additions & 2 deletions installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,20 @@ Pre-installation steps
Installation process
--------------------

.. image:: /images/1.7.2/installation_step_1.png

* Go to :menuselection:`System --> Magento Connect --> Magento Connect Manager` and enter your admin credentials to get logged in.
* 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.
* 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.

.. image:: /images/1.7.2/installation_step_2.png

* 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.

.. image:: /images/1.7.2/installation_step_3.png

* 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.

.. image:: /images/1.7.2/installation_step_4.png

* Proceed to the post-installation steps.

Post-installation steps
Expand Down
30 changes: 30 additions & 0 deletions login.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Login with Amazon
=================
**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.

Requirements
------------
**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.

`Login with Amazon` button
--------------------------
The `Login with Amazon` button appears in several places in the shop:

* on the customer login page,
* on the customer registration page.

.. image:: /images/1.7.2/login_screenshot_1.png

You can also place the `Login with Amazon` button in any place you like by including following statement in the template file:

.. code-block:: php
<?php echo Mage::helper('amazonpayments')->getLoginWithAmazonButton(); ?>
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.

.. image:: /images/1.7.2/order_step_2.png

After a successful login the customer is redirected to the user area in your shop.

.. 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.
34 changes: 32 additions & 2 deletions overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,16 @@ The extension is a pure payment solution. No item level is communicated to Amazo
Extension features
------------------

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

Getting the extension
---------------------
Expand All @@ -29,6 +31,34 @@ Refer to the :ref:`installation` section to get more details concerning installa
Changelog
---------

Version 1.7.2
~~~~~~~~~~~~~

Major Highlights
''''''''''''''''

* Implemented multilanguage feature for Login with Amazon

Improvements
''''''''''''

* Implemented re-authorization after the first authorization expires
* Putting order on hold for some kinds of closed authorization
* Added reason code of the transaction status directly to the order comments
* Added store name to SetOrderReferenceDetails call

Changes
'''''''

* Updated Amazon Payments SDK library to 1.0.14


Fixes
'''''

* Fixed Firefox redirect experience issue
* Fixed issues in the splitting full customer name helper function

Version 1.6.4
~~~~~~~~~~~~~

Expand Down
Loading

0 comments on commit b0fc7a9

Please sign in to comment.