summaryrefslogtreecommitdiff
path: root/api/integration-general.rst
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2016-12-26 23:27:28 +0100
committerMarcello Stanisci <marcello.stanisci@inria.fr>2017-01-27 10:42:50 +0100
commit3ee973fe5892dba1384dc4ca97e46148e479febd (patch)
tree4158d8d40c3adaaa6363d6402a81bae8b7883ad4 /api/integration-general.rst
parent4feb2deebe4118468ef75ac0c7ccf52000e660fe (diff)
downloaddocs-3ee973fe5892dba1384dc4ca97e46148e479febd.tar.gz
docs-3ee973fe5892dba1384dc4ca97e46148e479febd.tar.bz2
docs-3ee973fe5892dba1384dc4ca97e46148e479febd.zip
Moving payment protocol on 'docs'
Diffstat (limited to 'api/integration-general.rst')
-rw-r--r--api/integration-general.rst82
1 files changed, 0 insertions, 82 deletions
diff --git a/api/integration-general.rst b/api/integration-general.rst
deleted file mode 100644
index 308ecf5a..00000000
--- a/api/integration-general.rst
+++ /dev/null
@@ -1,82 +0,0 @@
-.. _integration-general:
-
-================================
-Taler Wallet Website Integration
-================================
-
-.. note::
- The wallet-Websites communication is switching to a new policy which
- is NOT based on DOM events, therefore obsoleting this page. To be soon
- documented.
-
-
-Websites (such as banks and online shops) can communicate with
-the Taler wallet by a standardized protocol.
-
-From a technical perspective, the Taller wallet communicates with
-the website by sending and receiving `DOM events <http://www.w3.org/TR/DOM-Level-3-Events/>`_
-on the bank website's ``HTMLDocument``.
-
-DOM events used by Taler have the prefix ``taler-``.
-
--------------------------
-Wallet Presence Awareness
--------------------------
-
-The bank website queries the wallet's presence by sending a ``taler-probe`` event. The
-event data should be `null`.
-
-If the wallet is present and active, it will respond with a ``taler-wallet-present`` event.
-
-While the user agent is displaying a website, the user might deactivate or
-re-activate the wallet. A Taler-aware *should* react to those events, and
-indicate to the user that they should (re-)enable the wallet if necessary.
-
-When the wallet is activated, the ``taler-wallet-load`` event is sent
-by the wallet. When the wallet is deactivated, the ``taler-wallet-unload`` event
-is sent by the wallet.
-
-.. _communication:
-
-----------------------
-Communication Example
-----------------------
-
-The bank website can send the event ``taler-XYZ`` with the event data ``eventData``
-to the wallet with the following JavaScript code:
-
-.. sourcecode:: javascript
-
- const myEvent = new CustomEvent("taler-XYZ", eventData);
- document.dispatchEvent(myEvent);
-
-Events can be received by installing a listener:
-
-
-.. sourcecode:: javascript
-
- function myListener(talerEvent) {
- // handle event here!
- }
- document.addEventListener("taler-XYZ", myListener);
-
-
---------------------
-Normalized Base URLs
---------------------
-
-Exchanges and merchants have a base URL for their service. This URL *must* be in a
-canonical form when it is stored (e.g. in the wallet's database) or transmitted
-(e.g. to a bank page).
-
-1. The URL must be absolute. This implies that the URL has a schema.
-2. The path component of the URL must end with a slash.
-3. The URL must not contain a fragment or query.
-
-When a user enters a URL that is, technically, relative (such as "alice.example.com/exchange"), wallets
-*may* transform it into a canonical base URL ("http://alice.example.com/exchange/"). Other components *should not* accept
-URLs that are not canonical.
-
-Rationale: Joining non-canonical URLs with relative URLs (e.g. "exchange.example.com" with "reserve/status")
-results in different and slightly unexpected behavior in some URL handling libraries.
-Canonical URLs give more predictable results with standard URL joining.