taler-docs

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

get-management-instances.rst (1539B)

      1 .. http:get:: /management/instances
      2 
      3   This is used to return the list of all the merchant instances.
      4   It is only available for the implicit ``admin`` instance.
      5 
      6   **Required permission:** ``instances-read``
      7 
      8   **Response:**
      9 
     10   :http:statuscode:`200 OK`:
     11     The backend has successfully returned the list of instances stored. Returns
     12     a `InstancesResponse`.
     13 
     14   **Details:**
     15 
     16   .. ts:def:: InstancesResponse
     17 
     18     interface InstancesResponse {
     19       // List of instances that are present in the backend (see `Instance`).
     20       instances: Instance[];
     21     }
     22 
     23   The `Instance` object describes the instance registered with the backend.
     24   It does not include the full details, only those that usually concern the frontend.
     25   It has the following structure:
     26 
     27   .. ts:def:: Instance
     28 
     29     interface Instance {
     30       // Merchant name corresponding to this instance.
     31       name: string;
     32 
     33       // Merchant public website.
     34       website?: string;
     35 
     36       // Merchant logo.
     37       logo?: ImageDataUrl;
     38 
     39       // Merchant instance this response is about ($INSTANCE).
     40       id: string;
     41 
     42       // Public key of the merchant/instance, in Crockford Base32 encoding.
     43       merchant_pub: EddsaPublicKey;
     44 
     45       // List of the payment targets supported by this instance. Clients can
     46       // specify the desired payment target in /order requests.  Note that
     47       // front-ends do not have to support wallets selecting payment targets.
     48       payment_targets: string[];
     49 
     50       // Has this instance been deleted (but not purged)?
     51       deleted: boolean;
     52    }