summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMS <ms@taler.net>2020-10-06 14:19:28 +0200
committerMS <ms@taler.net>2020-10-06 14:19:28 +0200
commit41626739d220e926ac799e9d8a2e57ba327d94ce (patch)
tree8071d41b703f6843ec4b9e5897dd791e7594c508
parent0f9a3b59aa49f46771c10a3d30528034ad49b3a8 (diff)
downloaddocs-41626739d220e926ac799e9d8a2e57ba327d94ce.tar.gz
docs-41626739d220e926ac799e9d8a2e57ba327d94ce.tar.bz2
docs-41626739d220e926ac799e9d8a2e57ba327d94ce.zip
nexus howto: introduction.
-rw-r--r--libeufin/nexus-howto.rst23
1 files changed, 14 insertions, 9 deletions
diff --git a/libeufin/nexus-howto.rst b/libeufin/nexus-howto.rst
index 4d15cd70..73784d57 100644
--- a/libeufin/nexus-howto.rst
+++ b/libeufin/nexus-howto.rst
@@ -3,6 +3,15 @@ Nexus How-To
.. contents:: Table of Contents
+Nexus is a Web service that provides a JSON abstraction layer to
+access bank accounts. It is **not** itself a bank, but a translator
+between JSON requests and more structured banking protocols (like
+EBICS, for example.), that are offered by actual banks.
+
+This document explains how to setup Nexus to access a bank account
+via the EBICS protocol. In order to follow all the steps below, the
+reader should already have one EBICS subscriber activated at their bank.
+
Obtain Nexus
============
Nexus belongs to the LibEuFin project, and can be downloaded via Git:
@@ -28,10 +37,6 @@ In case of success, the two following commands should be found:
Connect Nexus with a EBICS account
==================================
-Nexus is a Web service that unifies banking protocols, like EBICS, under
-one JSON-based abstraction layer. Therefore, "using Nexus" means having
-a running Nexus service that will receive the requests from another command
-line program that is as well offered along LibEuFin.
Use the following command to *(1) run the nexus service*:
@@ -51,8 +56,8 @@ via the EBICS protocol, but a API to create less privileged users is
as well offered.
Nexus needs now to associate the user to a EBICS subscriber that was
-activated on the bank. In the terminology, this is called *(3) creating
-a EBICS connection*.
+activated on the bank. In the Nexus terminology, this is called *(3)
+creating a EBICS connection*.
.. code-block:: shell
@@ -69,19 +74,19 @@ a EBICS connection*.
$NEXUS_URL
If the previous command succeeded, Nexus must communicate all the details
-to the bank. Therefore, it will *(4) bootstrap the connection*.
+to the bank. Therefore, it will *(4) synchronize the connection*.
.. code-block:: shell
./libeufin-cli \
connections \
- bootstrap-connection \
+ sync \
--connection-name $NEXUS_BANK_CONNECTION_NAME \
--nexus-user-id $NEXUS_USER \
--nexus-password $NEXUS_PASSWORD \
$NEXUS_URL
-Once the connection is bootstrapped, Nexus needs to import locally the data
+Once the connection is synchronized, Nexus needs to import locally the data
corresponding to the bank accounts offered by the bank connection just made.
The command below *(5) downloads the list of the bank accounts offered by the*
``$NEXUS_BANK_CONNECTION_NAME``.