diff options
author | MS <ms@taler.net> | 2022-12-05 17:54:53 +0100 |
---|---|---|
committer | MS <ms@taler.net> | 2022-12-05 17:54:53 +0100 |
commit | 5c3f1eea5bb0d8a2f028404168afc16688b1307d (patch) | |
tree | 9c1c73e76fe11c57bdd7284f2cf13f438e488114 | |
parent | b611f3d106985566c854efcfcfc742e02d71064b (diff) | |
download | docs-5c3f1eea5bb0d8a2f028404168afc16688b1307d.tar.gz docs-5c3f1eea5bb0d8a2f028404168afc16688b1307d.tar.bz2 docs-5c3f1eea5bb0d8a2f028404168afc16688b1307d.zip |
Sandbox API.
Create legacy API section.
-rw-r--r-- | libeufin/api-sandbox.rst | 99 |
1 files changed, 44 insertions, 55 deletions
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst index 93353eb1..a13140e1 100644 --- a/libeufin/api-sandbox.rst +++ b/libeufin/api-sandbox.rst @@ -6,16 +6,14 @@ Sandbox API ########### Demobanks. -^^^^^^^^^^ +========== Sandbox is designed to allow multiple *demobanks* being hosted, where every demobank can have its own configuration (including a different currency). A demobank has a name, although currently only one demobank, named ``default``, is supported. Such demobank -activates the API segment ``/demobanks/default``, under which other -APIs are then served. Those APIs include Access API, Integration -API, (part of the) Wire Gateway API (the add-incoming call), and -:ref:`one call to create EBICS subscribers <demobank-create-ebics-subscriber>`. +activates the API segment ``/demobanks/default``, under which several +APIs are then served. The following sections describe all such APIs. Access API. ^^^^^^^^^^^ @@ -38,26 +36,53 @@ only the :ref:`admin/add-incoming <twg-admin-add-incoming>` endpoint is implemented. This endpoint allows testing, but the rest of this API does never involve the Sandbox. +EBICS API. +^^^^^^^^^^ + +.. _demobank-create-ebics-subscriber: + +.. http:post:: /demobanks/default/ebics/subscribers + + Allows (only) the *admin* user to associate a bank account + to a EBICS subscriber. If the latter does not exist, it is + created. + + **Request:** + + .. ts:def:: SubscriberRequest + + interface SubscriberRequest { + + // hostID + hostID: string; + + // userID + userID: string; + + // partnerID + partnerID: string; + + // systemID, optional. + systemID: string; + + // Label of the bank account to associate with + // this subscriber. + demobankAccountLabel: string; + } + .. note:: The following endpoints are **not** served under the ``/demobank/default`` segment. -EBICS. -^^^^^^ +Legacy API. +=========== Except of the main EBICS handler located at /ebicsweb, all the EBICS calls have to authenticate the 'admin' user via the HTTP basic auth scheme. -HTTP Service -++++++++++++ - -.. http:post:: /ebicsweb - - Serves all the Ebics requests. - -Hosts. -++++++ +EBICS Hosts. +^^^^^^^^^^^^ .. http:post:: /admin/ebics/hosts @@ -99,8 +124,8 @@ Hosts. meant for tests (as the Sandbox itself is) and no backup will be produced along this operation. -Subscribers. -++++++++++++ +EBICS Subscribers. +^^^^^^^^^^^^^^^^^^ .. http:post:: /admin/ebics/bank-accounts @@ -134,37 +159,6 @@ Subscribers. } -.. _demobank-create-ebics-subscriber: - -.. http:post:: /demobanks/default/ebics/subscribers - - Allows (only) the *admin* user to associate a bank account - to a EBICS subscriber. If the latter does not exist, it is - created. - - **Request:** - - .. ts:def:: SubscriberRequest - - interface SubscriberRequest { - - // hostID - hostID: string; - - // userID - userID: string; - - // partnerID - partnerID: string; - - // systemID, optional. - systemID: string; - - // Label of the bank account to associate with - // this subscriber. - demobankAccountLabel: string; - } - .. http:get:: /admin/ebics/subscribers Shows the list of all the subscribers in the system. @@ -288,9 +282,6 @@ registration of customers is offered via the :doc:`/core/api-bank-access`. Transactions. ^^^^^^^^^^^^^ -JSON. -+++++ - .. http:get:: /admin/bank-accounts/$accountLabel/transactions Inform about all the transactions of one bank account. @@ -386,12 +377,10 @@ JSON. subject: string; } -Camt. -+++++ .. http:post:: /admin/payments/camt - Return the last statement of the requesting account. + Return the last camt.053 document from the requesting account. **Request** |