taler-docs

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

get-management-instances.rst (1611B)

      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   :http:statuscode:`401 Unauthorized`:
     14     The request is unauthorized.
     15 
     16   **Details:**
     17 
     18   .. ts:def:: InstancesResponse
     19 
     20     interface InstancesResponse {
     21       // List of instances that are present in the backend (see `Instance`).
     22       instances: Instance[];
     23     }
     24 
     25   The `Instance` object describes the instance registered with the backend.
     26   It does not include the full details, only those that usually concern the frontend.
     27   It has the following structure:
     28 
     29   .. ts:def:: Instance
     30 
     31     interface Instance {
     32       // Merchant name corresponding to this instance.
     33       name: string;
     34 
     35       // Merchant public website.
     36       website?: string;
     37 
     38       // Merchant logo.
     39       logo?: ImageDataUrl;
     40 
     41       // Merchant instance this response is about ($INSTANCE).
     42       id: string;
     43 
     44       // Public key of the merchant/instance, in Crockford Base32 encoding.
     45       merchant_pub: EddsaPublicKey;
     46 
     47       // List of the payment targets supported by this instance. Clients can
     48       // specify the desired payment target in /order requests.  Note that
     49       // front-ends do not have to support wallets selecting payment targets.
     50       payment_targets: string[];
     51 
     52       // Has this instance been deleted (but not purged)?
     53       deleted: boolean;
     54    }