diff options
Diffstat (limited to 'libeufin/nexus-howto.rst')
-rw-r--r-- | libeufin/nexus-howto.rst | 23 |
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``. |