[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: overview as 1.1
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: overview as 1.1 |
Date: |
Sat, 20 May 2023 18:50:43 +0200 |
This is an automated email from the git hooks/post-receive script.
grothoff pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new 6703cf9f overview as 1.1
6703cf9f is described below
commit 6703cf9fae436e2d964e91588825cbbb9973859b
Author: Christian Grothoff <grothoff@gnunet.org>
AuthorDate: Sat May 20 18:50:40 2023 +0200
overview as 1.1
---
core/{index.rst => api-overview.rst} | 30 +-----
core/index.rst | 176 +----------------------------------
2 files changed, 4 insertions(+), 202 deletions(-)
diff --git a/core/index.rst b/core/api-overview.rst
similarity index 91%
copy from core/index.rst
copy to core/api-overview.rst
index c2b646b5..18f05d7d 100644
--- a/core/index.rst
+++ b/core/api-overview.rst
@@ -19,33 +19,6 @@
@author Marcello Stanisci
@author Christian Grothoff
----------------------------
-Core Protocol Specification
----------------------------
-
-This chapter describes the APIs used in the GNU Taler project. It includes
-both APIs that are pre-existing as well as APIs specific to the project.
-
-These *protocol specification* defines the HTTP-based, predominantly RESTful
-interfaces between the core components of Taler.
-
-
-.. toctree::
- :maxdepth: 2
-
- api-common
- api-error
- api-exchange
- api-merchant
- api-auditor
- api-sync
- api-taldir
- api-mailbox
- api-bank
-
-.. toctree::
- :hidden:
-
========
Overview
========
@@ -219,3 +192,6 @@ Overview
**Consumers**: LibEuFin Nexus
**Providers**: LibEuFin Sandbox, Banks
+
+
+
diff --git a/core/index.rst b/core/index.rst
index c2b646b5..9ce2cc17 100644
--- a/core/index.rst
+++ b/core/index.rst
@@ -33,8 +33,8 @@ interfaces between the core components of Taler.
.. toctree::
:maxdepth: 2
+ api-overview
api-common
- api-error
api-exchange
api-merchant
api-auditor
@@ -45,177 +45,3 @@ interfaces between the core components of Taler.
.. toctree::
:hidden:
-
-========
-Overview
-========
-
- * 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>`
-
-
- * Taler Exchange Management API
-
- **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>`
-
-
- * Taler Merchant Backend Public API
-
- **Summary**: Allows communication between merchants and users' wallets.
-
- **Providers**: GNU Taler Merchant backend
-
- **Consumers**: Wallet
-
- :doc:`Docs <api-merchant>`
-
- * Taler Merchant Backend Private 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>`
-
- * Taler Wallet Core API
-
- **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
-
- * Taler Bank Integration API
-
- **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>`
-
- * 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.
-
- **Providers**: LibEuFin demobank, Taler Fakebank (partial)
-
- **Consumers**: Cashier App, demobank-ui
-
- :doc:`Docs <api-bank-access>`
-
-
- * Taler Bank Circuits API
-
- **Summary**: Allows management of bank user accounts in a regional
currency bank deployment.
-
- **Providers**: LibEuFin Sandbox demobank
-
- **Consumers**: demobank-ui
-
- * Taler Wire Gateway API
-
- **Summary**: Allows the Taler Exchange to query incoming transactions and
initiate payments with a protocol that abstracts away details of the underlying
banking system.
-
- **Providers**: Taler fakebank, LibEuFin Nexus, Depoloymerization wire
gateway
-
- **Consumers**: GNU Taler Exchange, Wire Auditor
-
- :doc:`Docs <api-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
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: overview as 1.1,
gnunet <=