summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Dold <florian@dold.me>2023-09-04 19:26:04 +0200
committerFlorian Dold <florian@dold.me>2023-09-04 19:26:04 +0200
commit2beaf1441d38e31ed2d50dc20d4cc2465dcb0798 (patch)
treec688f77a6f4cf17cbb47f80990b706e0cdaa3c91
parent17af81b8426c28cc3347933cf2abf1d64b8f9200 (diff)
downloaddocs-2beaf1441d38e31ed2d50dc20d4cc2465dcb0798.tar.gz
docs-2beaf1441d38e31ed2d50dc20d4cc2465dcb0798.tar.bz2
docs-2beaf1441d38e31ed2d50dc20d4cc2465dcb0798.zip
formatting, no more libeufin sandbox API
-rw-r--r--core/api-overview.rst202
1 files changed, 78 insertions, 124 deletions
diff --git a/core/api-overview.rst b/core/api-overview.rst
index a475a628..0df30ccd 100644
--- a/core/api-overview.rst
+++ b/core/api-overview.rst
@@ -23,170 +23,124 @@
Overview
========
- * Taler Exchange Public API
+.. rubric:: Taler Exchange Public API
+* **Summary**: Public API for the payment service provider component of GNU Taler.
+* **Providers**: GNU Taler Exchange
+* **Consumers**: Wallet, Merchant
+* :doc:`Docs <api-exchange>`
- **Summary**: Public API for the payment service provider component of GNU Taler.
+.. rubric:: Taler Exchange Management API
- **Providers**: GNU Taler Exchange
+* **Summary**: Management API for the payment service provider component of GNU Taler.
+* **Providers**: GNU Taler Exchange
+* **Consumers**: Exchange tooling (``taler-exchange-offline``), Auditor
+* :doc:`Docs <api-exchange>`
- **Consumers**: Wallet, Merchant
+.. rubric:: Taler Merchant Backend Public API
- :doc:`Docs <api-exchange>`
+* **Summary**: Allows communication between merchants and users' wallets.
+* **Providers**: GNU Taler Merchant backend
+* **Consumers**: Wallet
+* :doc:`Docs <api-merchant>`
+.. rubric:: Taler Merchant Backend Private API
- * Taler Exchange Management API
+* **Summary**: Allows the merchant to manage Taler-based payments and related functionality.
+* **Providers**: GNU Taler Merchant backend
+* **Consumers**: Merchant's shop Website backend, Merchant PoS app, Merchant Backoffice UI
+* :doc:`Docs <api-merchant>`
- **Summary**: Management API for the payment service provider component of GNU Taler.
+.. rubric:: Taler Wallet Core API
- **Providers**: GNU Taler Exchange
+* **Summary**: API to access functionality of the Taler Wallet service running locally on user's devices.
+* **Providers**: wallet-core
+* **Consumers**: UIs for the GNU Taler wallet
- **Consumers**: Exchange tooling (``taler-exchange-offline``), Auditor
+.. rubric:: Taler Bank Integration API
- :doc:`Docs <api-exchange>`
+* **Summary**: Offered by banks to provide the wallet/user with more information about ongoing withdrawals of Taler digital cash.
+* **Providers**: Taler fakebank, LibEuFin demobank, Banks (that provide extra Taler support)
+* **Consumers**: Taler Wallet
+* :doc:`Docs <api-bank-integration>`
+.. rubric:: Libefin Bank API
- * Taler Merchant Backend Public API
+* **Summary**: Protocol to manage a simple core bank with optional regional
+ currency support. Allows access to a bank account by the owner of the
+ account. The owner can access the account balance, transaction list, and initate
+ payments.
+* **Providers**: LibEuFin demobank, Taler Fakebank (partial)
+* **Consumers**: Cashier App, demobank-ui
+* :doc:`Docs <api-libeufin-bank>`
- **Summary**: Allows communication between merchants and users' wallets.
- **Providers**: GNU Taler Merchant backend
+.. rubric:: Taler Wire Gateway API
- **Consumers**: Wallet
+* **Summary**: Allows the Taler Exchange to query incoming transactions and initiate payments with a protocol that abstracts away details of the underlying banking system.
- :doc:`Docs <api-merchant>`
+* **Providers**: Taler fakebank, LibEuFin Nexus, Depoloymerization wire gateway
- * Taler Merchant Backend Private API
+* **Consumers**: GNU Taler Exchange, Wire Auditor
- **Summary**: Allows the merchant to manage Taler-based payments and related functionality.
+* :doc:`Docs <api-bank-wire>`
- **Providers**: GNU Taler Merchant backend
+.. rubric:: Taler Sync API
- **Consumers**: Merchant's shop Website backend, Merchant PoS app, Merchant Backoffice UI
+* **Summary**: Encrypted Data blob storage and retrieval API with payments for storage handled by GNU Taler payments.
- :doc:`Docs <api-merchant>`
+* **Providers**: GNU Taler Sync service
- * Taler Wallet Core API
+* **Consumers**: Taler Wallet
- **Summary**: API to access functionality of the Taler Wallet service running locally on user's devices.
+* :doc:`Docs <api-sync>`
- **Providers**: wallet-core
+.. rubric:: Taler Auditor API
- **Consumers**: UIs for the GNU Taler wallet
+* **Summary**: Reporting of certain transactions or potential problems directly to the auditor.
+* **Providers**: GNU Taler Auditor service
+* **Consumers**: GNU Taler Merchant, eventually Taler Wallet
+* :doc:`Docs <api-auditor>`
- * Taler Bank Integration API
+.. rubric:: Taldir API
- **Summary**: Offered by banks to provide the wallet/user with more information about ongoing withdrawals of Taler digital cash.
+* **Summary**: Looking up of Taler mailboxes associated with particular Internet service addresses.
+* **Providers**: GNU TalDir service
+* **Consumers**: GNU Taler Wallet
+* :doc:`Docs <api-taldir>`
- **Providers**: Taler fakebank, LibEuFin demobank, Banks (that provide extra Taler support)
+.. rubric:: Taler Mailbox API
- **Consumers**: Taler Wallet
+* **Summary**: Tansmission of encrypted payment messages between Taler wallets.
+* **Providers**: GNU Taler Mailbox service
+* **Consumers**: GNU Taler Wallet
+* :doc:`Docs <api-mailbox>`
- :doc:`Docs <api-bank-integration>`
+.. rubric:: Anastasis Provider Public API
- * Libefin Bank API
+* **Summary**: Backup for secret splitting backup and recovery with GNU Anastasis providers.
+* **Providers**: GNU Anastasis providers
+* **Consumers**: Anastasis core client implementations (C implementation, TypeScript implementation)
- **Summary**: Protocol to manage a simple core bank with optional regional
- currency support. Allows access to a bank account by the owner of the
- account. The owner can access the account balance, transaction list, and initate
- payments.
+.. rubric:: Anastasis Reducer API
- **Providers**: LibEuFin demobank, Taler Fakebank (partial)
+* **Summary**: API used to step through the backup and recovery process of GNU Anastasis.
+* **Providers**: Anastasis core client implementations (C implementation, TypeScript implementation)
+* **Consumers**: Anastasis UIs (CLI, GTK, anastasis-webui)
- **Consumers**: Cashier App, demobank-ui
+.. rubric:: LibEuFin Nexus API
- :doc:`Docs <api-libeufin-bank>`
+* **Summary**: API used to configure and access LibEuFin nexus, a generic server that supports multiple protocols to access a bank account.
+* **Providers**: LibEuFin Nexus service
- * Taler Wire Gateway API
+* **Consumers**: ``libeufin-cli``, (future) LibEuFin Web UI
- **Summary**: Allows the Taler Exchange to query incoming transactions and initiate payments with a protocol that abstracts away details of the underlying banking system.
+.. rubric:: EBICS
- **Providers**: Taler fakebank, LibEuFin Nexus, Depoloymerization wire gateway
-
- **Consumers**: GNU Taler Exchange, Wire Auditor
-
- :doc:`Docs <api-bank-wire>`
-
- * Taler Sync API
-
- **Summary**: Encrypted Data blob storage and retrieval API with payments for storage handled by GNU Taler payments.
-
- **Providers**: GNU Taler Sync service
-
- **Consumers**: Taler Wallet
-
- :doc:`Docs <api-sync>`
-
- * Taler Auditor API
-
- **Summary**: Reporting of certain transactions or potential problems directly to the auditor.
-
- **Providers**: GNU Taler Auditor service
-
- **Consumers**: GNU Taler Merchant, eventually Taler Wallet
-
- :doc:`Docs <api-auditor>`
-
- * Taldir API
-
- **Summary**: Looking up of Taler mailboxes associated with particular Internet service addresses.
-
- **Providers**: GNU TalDir service
-
- **Consumers**: GNU Taler Wallet
-
- :doc:`Docs <api-taldir>`
-
- * Taler Mailbox API
-
- **Summary**: Tansmission of encrypted payment messages between Taler wallets.
-
- **Providers**: GNU Taler Mailbox service
-
- **Consumers**: GNU Taler Wallet
-
- :doc:`Docs <api-mailbox>`
-
- * Anastasis Provider Public API
-
- **Summary**: Backup for secret splitting backup and recovery with GNU Anastasis providers.
-
- **Providers**: GNU Anastasis providers
-
- **Consumers**: Anastasis core client implementations (C implementation, TypeScript implementation)
-
- * Anastasis Reducer API
-
- **Summary**: API used to step through the backup and recovery process of GNU Anastasis.
-
- **Providers**: Anastasis core client implementations (C implementation, TypeScript implementation)
-
- **Consumers**: Anastasis UIs (CLI, GTK, anastasis-webui)
-
- * LibEuFin Nexus API
-
- **Summary**: API used to configure and access LibEuFin nexus, a generic server that supports multiple protocols to access a bank account.
-
- **Providers**: LibEuFin Nexus service
-
- **Consumers**: ``libeufin-cli``, (future) LibEuFin Web UI
-
- * LibEuFin Sandbox API
-
- **Summary** API used to configure the LibEuFin sandbox, a simulator for various protocols related to core banking that would typically offered by banks.
-
- **Providers**: LibEuFin Sandbox service
-
- **Consumers**: ``libeufin-cli``, (future) LibEuFin Web UI
-
- * EBICS
-
- **Summary**: Allows businesses/banks/consumers to exchange data with a bank's core banking system.
-
- **Consumers**: LibEuFin Nexus
-
- **Providers**: LibEuFin Sandbox, Banks
+* **Summary**: Allows businesses/banks/consumers to exchange data with a bank's core banking system.
+* **Consumers**: LibEuFin Nexus
+* **Providers**: libeufin-bank, Banks