taler-docs

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

get-config.rst (1274B)


      1 .. http:get:: /config
      2 
      3   Get the protocol version and some meta data about the auditor.
      4 
      5   **Response:**
      6 
      7   :http:statuscode:`200 OK`:
      8     The auditor responds with an `AuditorVersion`_ object. This request should
      9     virtually always be successful.
     10 
     11   **Details:**
     12 
     13   .. _AuditorVersion:
     14   .. code-block:: tsref
     15 
     16     interface AuditorVersion {
     17       // libtool-style representation of the Taler protocol version, see
     18       // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
     19       // The format is "current:revision:age".  Note that the auditor
     20       // protocol is versioned independently of the exchange's protocol.
     21       version: string;
     22 
     23       // URN of the implementation (needed to interpret 'revision' in version).
     24       // @since v0, may become mandatory in the future.
     25       implementation?: string;
     26 
     27       // Return which currency this auditor is auditing for.
     28       currency: string;
     29 
     30       // EdDSA master public key of the auditor.
     31       auditor_public_key: EddsaPublicKey;
     32 
     33       // EdDSA master public key of the exchange.
     34       // Added in protocol v1.
     35       exchange_master_public_key: EddsaPublicKey;
     36     }
     37 
     38   .. note::
     39 
     40     This endpoint is still experimental (and is not yet implemented at the
     41     time of this writing).