diff options
author | Christian Grothoff <christian@grothoff.org> | 2023-02-24 15:13:10 +0100 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2023-02-24 15:13:10 +0100 |
commit | 9f583cdf4398721185537db2df6d7aef3b409e7f (patch) | |
tree | fba06d1b13f64ed88c670eaa97c8adc7749eeb2f /core | |
parent | 7b154397360bb10a37c2515010884813e3564c41 (diff) | |
download | docs-9f583cdf4398721185537db2df6d7aef3b409e7f.tar.gz docs-9f583cdf4398721185537db2df6d7aef3b409e7f.tar.bz2 docs-9f583cdf4398721185537db2df6d7aef3b409e7f.zip |
fix api index
Diffstat (limited to 'core')
-rw-r--r-- | core/index.rst | 219 |
1 files changed, 86 insertions, 133 deletions
diff --git a/core/index.rst b/core/index.rst index c06698db..2a8352db 100644 --- a/core/index.rst +++ b/core/index.rst @@ -46,227 +46,180 @@ interfaces between the core components of Taler. api-bank-integration api-bank-access +.. toctree:: + :hidden: ======== Overview ======== -------------------------- -Taler Exchange Public API -------------------------- - -**Summary**: Public API for the payment service provider component of GNU Taler. - -**Providers**: GNU Taler Exchange + * Taler Exchange Public API -**Consumers**: Wallet, Merchant -:doc:`Docs <api-exchange>` + **Summary**: Public API for the payment service provider component of GNU Taler. + **Providers**: GNU Taler Exchange ------------------------------ -Taler Exchange Management API ------------------------------ + **Consumers**: Wallet, Merchant + + :doc:`Docs <api-exchange>` -**Summary**: Management API for the payment service provider component of GNU Taler. -**Providers**: GNU Taler Exchange + * Taler Exchange Management API -**Consumers**: Exchange tooling (``taler-exchange-offline``), Auditor + **Summary**: Management API for the payment service provider component of GNU Taler. -:doc:`Docs <api-exchange>` + **Providers**: GNU Taler Exchange + **Consumers**: Exchange tooling (``taler-exchange-offline``), Auditor ---------------------------------- -Taler Merchant Backend Public API ---------------------------------- + :doc:`Docs <api-exchange>` -**Summary**: Allows communication between merchants and users' wallets. -**Providers**: GNU Taler Merchant backend + * Taler Merchant Backend Public API -**Consumers**: Wallet + **Summary**: Allows communication between merchants and users' wallets. -:doc:`Docs <api-merchant>` + **Providers**: GNU Taler Merchant backend + **Consumers**: Wallet ----------------------------------- -Taler Merchant Backend Private API ----------------------------------- + :doc:`Docs <api-merchant>` -**Summary**: Allows the merchant to manage Taler-based payments and related functionality. + * Taler Merchant Backend Private API -**Providers**: GNU Taler Merchant backend + **Summary**: Allows the merchant to manage Taler-based payments and related functionality. -**Consumers**: Merchant's shop Website backend, Merchant PoS app, Merchant -Backoffice UI + **Providers**: GNU Taler Merchant backend -:doc:`Docs <api-merchant>` + **Consumers**: Merchant's shop Website backend, Merchant PoS app, Merchant Backoffice UI + :doc:`Docs <api-merchant>` ---------------------- -Taler Wallet Core API ---------------------- + * Taler Wallet Core API -**Summary**: API to access functionality of the Taler Wallet service running -locally on user's devices. + **Summary**: API to access functionality of the Taler Wallet service running locally on user's devices. -**Providers**: wallet-core + **Providers**: wallet-core -**Consumers**: UIs for the GNU Taler wallet + **Consumers**: UIs for the GNU Taler wallet --------------------------- -Taler Bank Integration API --------------------------- + * Taler Bank Integration API -**Summary**: Offered by banks to provide the wallet/user with more information -about ongoing withdrawals of Taler digital cash. + **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) + **Providers**: Taler fakebank, LibEuFin demobank, Banks (that provide extra Taler support) -**Consumers**: Taler Wallet + **Consumers**: Taler Wallet -:doc:`Docs <api-bank-integration>` + :doc:`Docs <api-bank-integration>` ---------------------- -Taler Bank Access API ---------------------- + * Taler Bank Access API -**Summary**: Protocol to manage access to a bank account by the owner of the account. -Allows access to account balance, transaction list, payment initiation. + **Summary**: Protocol to manage access to a bank account by the owner of the account. Allows access to account balance, transaction list, payment initiation. -**Providers**: LibEuFin demobank, Taler Fakebank (partial) + **Providers**: LibEuFin demobank, Taler Fakebank (partial) -**Consumers**: Cashier App, demobank-ui + **Consumers**: Cashier App, demobank-ui -:doc:`Docs <api-bank-access>` + :doc:`Docs <api-bank-access>` ------------------------ -Taler Bank Circuits API ------------------------ -**Summary**: Allows management of bank user accounts in a regional -currency bank deployment. + * Taler Bank Circuits API -**Providers**: LibEuFin Sandbox demobank + **Summary**: Allows management of bank user accounts in a regional currency bank deployment. -**Consumers**: demobank-ui + **Providers**: LibEuFin Sandbox demobank ----------------------- -Taler Wire Gateway API ----------------------- + **Consumers**: demobank-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. + * Taler Wire Gateway API -**Providers**: Taler fakebank, LibEuFin Nexus, Depoloymerization wire gateway + **Summary**: Allows the Taler Exchange to query incoming transactions and initiate payments with a protocol that abstracts away details of the underlying banking system. -**Consumers**: GNU Taler Exchange, Wire Auditor + **Providers**: Taler fakebank, LibEuFin Nexus, Depoloymerization wire gateway -:doc:`Docs <api-wire>` + **Consumers**: GNU Taler Exchange, Wire Auditor --------------- -Taler Sync API --------------- + :doc:`Docs <api-wire>` -**Summary**: Encrypted Data blob storage and retrieval API with payments for -storage handled by GNU Taler payments. + * Taler Sync API -**Providers**: GNU Taler Sync service + **Summary**: Encrypted Data blob storage and retrieval API with payments for storage handled by GNU Taler payments. -**Consumers**: Taler Wallet + **Providers**: GNU Taler Sync service -:doc:`Docs <api-sync>` + **Consumers**: Taler Wallet + :doc:`Docs <api-sync>` ------------------ -Taler Auditor API ------------------ + * Taler Auditor API -**Summary**: Reporting of certain transactions or potential problems directly to the auditor. + **Summary**: Reporting of certain transactions or potential problems directly to the auditor. -**Providers**: GNU Taler Auditor service + **Providers**: GNU Taler Auditor service -**Consumers**: GNU Taler Merchant, eventually Taler Wallet + **Consumers**: GNU Taler Merchant, eventually Taler Wallet -:doc:`Docs <api-auditor>` + :doc:`Docs <api-auditor>` + * Taldir API ----------- -Taldir API ----------- + **Summary**: Looking up of Taler mailboxes associated with particular Internet service addresses. -**Summary**: Looking up of Taler mailboxes associated with particular Internet service addresses. + **Providers**: GNU TalDir service -**Providers**: GNU TalDir service + **Consumers**: GNU Taler Wallet -**Consumers**: GNU Taler Wallet + :doc:`Docs <api-taldir>` -:doc:`Docs <api-taldir>` + * Taler Mailbox API ------------------ -Taler Mailbox API ------------------ + **Summary**: Tansmission of encrypted payment messages between Taler wallets. -**Summary**: Tansmission of encrypted payment messages between Taler wallets. + **Providers**: GNU Taler Mailbox service -**Providers**: GNU Taler Mailbox service + **Consumers**: GNU Taler Wallet -**Consumers**: GNU Taler Wallet + :doc:`Docs <api-mailbox>` -:doc:`Docs <api-mailbox>` + * Anastasis Provider Public API ------------------------------ -Anastasis Provider Public API ------------------------------ + **Summary**: Backup for secret splitting backup and recovery with GNU Anastasis providers. -**Summary**: Backup for secret splitting backup and recovery with GNU Anastasis providers. + **Providers**: GNU Anastasis providers -**Providers**: GNU Anastasis providers + **Consumers**: Anastasis core client implementations (C implementation, TypeScript implementation) -**Consumers**: Anastasis core client implementations (C implementation, TypeScript implementation) + * Anastasis Reducer API ---------------------- -Anastasis Reducer API ---------------------- + **Summary**: API used to step through the backup and recovery process of GNU Anastasis. -**Summary**: API used to step through the backup and recovery process of GNU Anastasis. + **Providers**: Anastasis core client implementations (C implementation, TypeScript implementation) -**Providers**: Anastasis core client implementations (C implementation, TypeScript implementation) + **Consumers**: Anastasis UIs (CLI, GTK, anastasis-webui) -**Consumers**: Anastasis UIs (CLI, GTK, anastasis-webui) + * LibEuFin Nexus API ------------------- -LibEuFin Nexus API ------------------- + **Summary**: API used to configure and access LibEuFin nexus, a generic server that supports multiple protocols to access a bank account. -**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 -**Providers**: LibEuFin Nexus service + **Consumers**: ``libeufin-cli``, (future) LibEuFin Web UI -**Consumers**: ``libeufin-cli``, (future) LibEuFin Web UI + * LibEuFin Sandbox API --------------------- -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. -**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 -**Providers**: LibEuFin Sandbox service + **Consumers**: ``libeufin-cli``, (future) LibEuFin Web UI -**Consumers**: ``libeufin-cli``, (future) LibEuFin Web UI + * EBICS ------ -EBICS ------ + **Summary**: Allows businesses/banks/consumers to exchange data with a bank's core banking system. -**Summary**: Allows businesses/banks/consumers to exchange data with a bank's -core banking system. + **Consumers**: LibEuFin Nexus -**Consumers**: LibEuFin Nexus + **Providers**: LibEuFin Sandbox, Banks -**Providers**: LibEuFin Sandbox, Banks |