taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

index.rst (1623B)


      1 ..
      2   This file is part of GNU TALER.
      3   Copyright (C) 2014-2025 Taler Systems SA
      4 
      5   TALER is free software; you can redistribute it and/or modify it under the
      6   terms of the GNU Affero General Public License as published by the Free Software
      7   Foundation; either version 2.1, or (at your option) any later version.
      8 
      9   TALER is distributed in the hope that it will be useful, but WITHOUT ANY
     10   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
     11   A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.
     12 
     13   You should have received a copy of the GNU Affero General Public License along with
     14   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
     15 
     16   @author Florian Dold
     17   @author Benedikt Muller
     18   @author Sree Harsha Totakura
     19   @author Marcello Stanisci
     20   @author Christian Grothoff
     21   @author Özgür Kesim
     22 
     23 -----------------
     24 API Specification
     25 -----------------
     26 
     27 This chapter describes the APIs used in the GNU Taler project.  It includes
     28 both APIs that are pre-existing as well as APIs specific to the project.
     29 
     30 These *protocol specifications* define the interfaces between the core
     31 components of GNU Taler.  Most of these interfaces use HTTP-based RESTful
     32 protocols using JSON.  In the documentation, we use TypeScript syntax to
     33 describe the JSON objects used in our REST APIs.
     34 
     35 
     36 .. toctree::
     37   :maxdepth: 1
     38 
     39   api-overview
     40   api-common
     41   api-exchange
     42   api-merchant
     43   ../wallet/wallet-core
     44   api-auditor
     45   api-sync
     46   api-challenger
     47   api-taldir
     48   api-mailbox
     49   index-bank-apis
     50   api-donau
     51   api-observability
     52   api-ebisync
     53 
     54 .. toctree::
     55   :hidden: