taler-docs

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

api-taldir.rst (2535B)

      1 ..
      2   This file is part of GNU TALER.
      3   Copyright (C) 2022 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 3.0, 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 Christian Grothoff
     17   @author Martin Schanzenbach
     18 
     19 .. _api-taldir:
     20 
     21 =====================
     22 Directory RESTful API
     23 =====================
     24 
     25 This is the API for the Taler Directory (TalDir) service which allows Taler wallets to
     26 securely associate an inbox service (URL and public key) with the alias of a
     27 wallet's user.  Wallets can also lookup the
     28 inbox of other users. This will enable wallets to make wallet-to-wallet
     29 payments to distant wallets where the target user is only identified by their
     30 alias. Examples for aliases include E-mail and phone numbers but also
     31 social handles.
     32 The service in principle allows registration of any valid URI as inbox
     33 service.
     34 For Taler, the URI is a link to a :ref:`mailbox <api-mailbox>`.
     35 
     36 The API specified here follows the :ref:`general conventions <http-common>`
     37 for all details not specified in the individual requests.
     38 The `glossary <https://docs.taler.net/taler-developer-manual.html#developer-glossary>`_
     39 defines all specific terms used in this section.
     40 
     41 
     42 
     43 ---------------
     44 Version History
     45 ---------------
     46 
     47 The current protocol version is **v0**.
     48 
     49 * Wallet-core uses the Directory API to register and resolve aliases for
     50   mailbox-based wallet-to-wallet communication.
     51 
     52 **Version history:**
     53 
     54 * ``v0``: Initial version.
     55 
     56 **Upcoming versions:**
     57 
     58 * None anticipated.
     59 
     60 **Ideas for future version:**
     61 
     62 * ``vXXX``: marker for features not yet targeted for release
     63 
     64 
     65 
     66 .. include:: tos.rst
     67 
     68 
     69 -------------------------
     70 Configuration information
     71 -------------------------
     72 
     73 .. include:: taldir/get-config.rst
     74 
     75 ------------------
     76 Alias registration
     77 ------------------
     78 
     79 .. include:: taldir/post-register-ALIASTYPE.rst
     80 
     81 
     82 .. include:: taldir/get-register-H_ALIAS-PINTAN.rst
     83 
     84 .. include:: taldir/post-H_ALIAS.rst
     85 
     86 ------------
     87 Alias lookup
     88 ------------
     89 
     90 .. include:: taldir/get-H_ALIAS.rst