From 22eadc2f204e7ee52cd4f8ed45f027ea433defc1 Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Mon, 27 Jul 2020 13:05:07 +0530 Subject: taler:// URIs --- core/taler-uri.rst | 45 ++++++++++++++++++++++++++++++++++----------- 1 file changed, 34 insertions(+), 11 deletions(-) (limited to 'core/taler-uri.rst') diff --git a/core/taler-uri.rst b/core/taler-uri.rst index ddb61322..b7134201 100644 --- a/core/taler-uri.rst +++ b/core/taler-uri.rst @@ -14,26 +14,27 @@ The basic syntax is as follows: taler://{action}/{+rest} +The alternative scheme name ``taler+http`` indicates that the referenced resource is to be accessed +via plain HTTP instead of HTTPS. This **should** only be used for testing. A production +version of the wallet **may** reject such URIs. + -------------------- Requesting a Payment -------------------- Payments are requested with the ``pay`` action. The parameters are a hierarchical identifier for the requested payment: - .. code:: none - taler://pay/{merchant_host}{/merchant_prefix_path*}/{order_id}/{session_id}{?insecure}{#ssid} + taler://pay/{merchant_host}{/merchant_prefix_path*}/{order_id}/{session_id}{?c}{#ssid} -* ``merchant_host`` is the hostname of the merchant +* ``merchant_host`` is the hostname (and optionally port) of the merchant * ``merchant_prefix_path`` is an optional list of path components that identifies the path prefix of the merchant base URL. * ``order_id`` is the order ID that the customer is asked to pay for * ``session_id`` is the optional session ID under which the payment takes place -* ``insecure`` is an optional query parameter. When "1", the ``merchant_host`` is contacted via HTTP. - When absent or "0", the ``merchant_host`` is contacted via HTTPS. +* ``c`` is the optional high-entropy order claim token * ``ssid`` is the optional WLAN SSID that the merchant can offer the wallet to connect to for internet connectivity - Examples: .. code:: none @@ -65,7 +66,7 @@ The action ``withdraw`` is used to trigger a bank-integrated withdrawal operatio .. code:: none - taler://withdraw/{bank_host}{/bank_prefix_path*}/{withdrawal_uid}{?insecure}{#ssid} + taler://withdraw/{bank_host}{/bank_prefix_path*}/{withdrawal_uid}{#ssid} * ``bank_host`` is the hostname of the merchant * ``bank_prefix_path`` is an optional list of path components that identifies the path prefix of the bank integration API base URL. @@ -97,13 +98,12 @@ A ``taler://refund`` URI instructs the wallet to download and apply available re .. code:: none - taler://refund/{merchant_host}{/merchant_prefix_path*}/{order_id}/{?insecure}{#ssid} + taler://refund/{merchant_host}{/merchant_prefix_path*}/{order_id}/{#ssid} + taler+http://refund/{merchant_host}{/merchant_prefix_path*}/{order_id}/{#ssid} * ``merchant_host`` is the hostname of the merchant * ``merchant_prefix_path`` is an optional list of path components that identifies the path prefix of the merchant base URL. * ``order_id`` is the order ID to check for refunds -* ``insecure`` is an optional query parameter. When "1", the ``merchant_host`` is contacted via HTTP. - When absent or "0", the ``merchant_host`` is contacted via HTTPS. * ``ssid`` is the optional WLAN SSID that the merchant can offer the wallet to connect to for internet connectivity @@ -116,7 +116,7 @@ a merchant and ask the user to accept/decline it. .. code:: none - taler://tip/{merchant_host}{/merchant_prefix_path*}/{tip_id}/{?insecure}{#ssid} + taler://tip/{merchant_host}{/merchant_prefix_path*}/{tip_id}/{#ssid} * ``merchant_host`` is the hostname of the merchant * ``merchant_prefix_path`` is an optional list of path components that identifies the path prefix of the merchant base URL. @@ -125,6 +125,29 @@ a merchant and ask the user to accept/decline it. When absent or "0", the ``merchant_host`` is contacted via HTTPS. * ``ssid`` is the optional WLAN SSID that the merchant can offer the wallet to connect to for internet connectivity + +---------------- +Adding exchanges +---------------- + +A ``taler://exchange/`` URI instructs the wallet to display a prompt to the user, asking +the user to confirm/decline adding the exchange to the list of trusted exchanges. + +.. code:: none + + taler://exchange/{exchange_host}{/exchange_prefix_path*}/ + +--------------- +Adding auditors +--------------- + +A ``taler://auditor/`` URI instructs the wallet to display a prompt to the user, asking +the user to confirm/decline adding the auditor to the list of trusted auditors. + +.. code:: none + + taler://auditor/{auditor_host}{/auditor_prefix_path*}/ + ---------------------------- Special URLs for fulfillment ---------------------------- -- cgit v1.2.3