diff options
author | MS <ms@taler.net> | 2023-01-17 10:25:58 +0100 |
---|---|---|
committer | MS <ms@taler.net> | 2023-01-17 10:25:58 +0100 |
commit | c544a4d84efe03b6905173a48edea54851424681 (patch) | |
tree | b7e42e763ca50ff271e98c56167efbb4c6af057d /libeufin | |
parent | fd8eb8e4f0cc1f17a5673dc485db742e59bda58b (diff) | |
download | docs-c544a4d84efe03b6905173a48edea54851424681.tar.gz docs-c544a4d84efe03b6905173a48edea54851424681.tar.bz2 docs-c544a4d84efe03b6905173a48edea54851424681.zip |
circuit API tutorial
pointing to all the available commands that
use the API and to the example scripts that
provide the SMS and e-mail TAN channels.
Diffstat (limited to 'libeufin')
-rw-r--r-- | libeufin/local-currencies-tutorial.rst | 33 |
1 files changed, 22 insertions, 11 deletions
diff --git a/libeufin/local-currencies-tutorial.rst b/libeufin/local-currencies-tutorial.rst index e09a622d..f2b55bef 100644 --- a/libeufin/local-currencies-tutorial.rst +++ b/libeufin/local-currencies-tutorial.rst @@ -27,16 +27,14 @@ configure *Sandbox* (= the service acting as the bank) with the following comman .. note:: The ``--without-registrations`` option allows *only the administrator* - to add new accounts. + to add new accounts. Without this option, other APIs may offer + unrestricted registrations. -.. note:: - - All the commands mentioned in the following steps - support a ``--help`` option that lists all the available - options under such command. +All the commands mentioned in the following steps support a ``--help`` +option that lists all the available options under the related command. -If the configuration step succeeded, Sandbox should be ready -to serve the bank for a currency named `NB`. +If the configuration step succeeded, Sandbox should be ready to serve the +bank for a currency named `NB`. In following step, we launch Sandbox by setting the administrator password as ``secret``. @@ -45,9 +43,7 @@ password as ``secret``. The following command launches Sandbox so that it writes TANs on the filesystem to ease the cash-out operations without - relying on an actual e-mail or SMS provider. See section - FIXME for e-mail or SMS based TANs. - + relying on an `actual e-mail or SMS provider <email-sms-setup_>`_. .. code-block:: console $ export LIBEUFIN_SANDBOX_ADMIN_PASSWORD=secret @@ -243,6 +239,16 @@ again the balance, and expect one error like the following: } +Finally, the following command shows a list that includes all +the operations that use the Circuit API: those named ``circuit-*``. + +.. code-block:: console + + libeufin-cli sandbox demobank + + +.. _email-sms-setup: + E-mail or SMS TAN setup ----------------------- @@ -277,3 +283,8 @@ phone number / e-mail address as their first command line argument. The way the invoked commands interact with their providers is out of the Sandbox scope. + +Finally, Libeufin ships two TAN commands as example. The e-mail +command relies on `GNU mail <mailutils.org>`_ and the SMS command +on the service offered by `<telesign.com>`_. Check ``contrib/libeufin-tan-sms.sh`` +and ``contrib/libeufin-tan-email.sh`` in the Libeufin repository. |