getServiceEndpointsForPOS

Returns a list of service endpoints for Berlin POS.

When called by any other API clients, returns error 1161.

Response

Field name Type Description

cayanGatewayURLs

array

List of Cayan (Merchant Warehouse) payment gateway URLs for this particular account. This only specifies the most appropriate service endpoints for the account to use; it does not indicate that the account is actually using Cayan payment integration.

This array may contain 0 or more records. If Cayan support has been disabled in this server, the array will be empty. Otherwise it will contain at least one record.

Each record in the array contains the following fields:

Field name	Type	Description
target	String	Service hostname
port	Integer	Service port
weight	Integer (0..65535)	For load balancing. See internal documentation.
priority	Integer (0..65535)	Priority of this host. See internal documentation.

avalaraGatewayURLs

array

URLs of gateways to the Avalara tax calculation service. This only specifies the most appropriate service endpoints to use, if needed, and does not indicate that the account is actually using Avalara integration.

This array may contain 0 or more records. If Avalara support has been disabled in this server, the array will be empty. Otherwise it will contain at least one record.

Each record in the array contains the following fields:

Field name	Type	Description
target	String	Service hostname
port	Integer	Service port
weight	Integer (0..65535)	For load balancing. See internal documentation.
priority	Integer (0..65535)	Priority of this host. See internal documentation.

pusherAuthenticationURLs

array

URLs of gateways to the Pusher messaging service, for this particular account.

This array may contain 0 or more records. If Pusher support has been disabled in this server, the array will be empty. Otherwise it will contain at least one record.

Each record in the array contains the following fields:

Field name	Type	Description
target	String	Service hostname
port	Integer	Service port
weight	Integer (0..65535)	For load balancing. See internal documentation.
priority	Integer (0..65535)	Priority of this host. See internal documentation.

strikeIronGatewayURLs

array

URLs of gateways to the StrikeIron (Informatica) tax rate lookup service, for this particular account.

This array may contain 0 or more records. If StrikeIron support has been disabled in this server, the array will be empty. Otherwise it will contain at least one record.

Each record in the array contains the following fields:

Field name	Type	Description
target	String	Service hostname
port	Integer	Service port
weight	Integer (0..65535)	For load balancing. See internal documentation.
priority	Integer (0..65535)	Priority of this host. See internal documentation.

paypalGatewayURLs

array

URLs of gateways to the PayPal payment service, for this particular account.

This array may contain 0 or more records. If PayPal support has been disabled in this server, the array will be empty. Otherwise it will contain at least one record.

Each record in the array contains the following fields:

Field name	Type	Description
target	String	Service hostname
port	Integer	Service port
weight	Integer (0..65535)	For load balancing. See internal documentation.
priority	Integer (0..65535)	Priority of this host. See internal documentation.

triPOSCloudPaymentURL

Object

This field is either null (if support for triPOS Cloud payments has not been configured on this server), or an object with two fields: "url" and "token". These are the endpoint of the triPOS Cloud payments proxy, and an authentication token for it.

Example:

"triPOSCloudPaymentURL": {
    "url": "https://tripos-proxy.example.com/TriPos/V1/",
    "token": "abcdefgh"
}

customerRegistryURLs

array

Information about standalone customer registry service.

This array may contain 0 or more records. If account does not use a standalone customer registry (customers are stored in Erply as usual), this list will be empty. Otherwise it will contain at least one record.

Each record in the array contains the following fields:

Field name	Type	Description
url	String	URL of the service endpoint (with "https://" protocol in the beginning and "/" in the end). Append the names of API calls (eg. "V1/Customer/create") to this URL.
token	Integer	Authentication token for the service. When the customer service reports the token has expired, call verifyUser again to get a new one.
priority	Integer (0..65535)	Priority of this host. A client must attempt to contact the target host with the lowest-numbered priority it can reach. Target hosts with the same priority should be tried in pseudorandom order.
weight	Integer (0..65535)	For load balancing. When selecting a target host among those that have the same priority, the chance of trying this one first should be proportional to its weight. Larger weights SHOULD be given a proportionately higher probability of being selected.

couponRegistryURLs

array

Information about standalone coupon registry service.

This array may contain 0 or more records. If account does not use a standalone coupon registry (coupons are stored in Erply as usual), this list will be empty. Otherwise it will contain at least one record.

Each record in the array contains the following fields:

Field name	Type	Description
url	String	URL of the service endpoint (with "https://" protocol in the beginning and "/" in the end). Append the names of API calls to this URL.
token	Integer	Authentication token for the service. When the coupon service reports the token has expired, call verifyUser again to get a new one.
priority	Integer (0..65535)	Priority of this host. A client must attempt to contact the target host with the lowest-numbered priority it can reach. Target hosts with the same priority should be tried in pseudorandom order.
weight	Integer (0..65535)	For load balancing. When selecting a target host among those that have the same priority, the chance of trying this one first should be proportional to its weight. Larger weights SHOULD be given a proportionately higher probability of being selected.

displayAdManagerURLs

array

Information about the service that provides advertisements to the point-of-sale customer display screen. (This information is meant for Berlin POS.)

This array may contain 0 or more records. If account has not been configured to use the advertisement manager, this list will be empty. Otherwise it will contain at least one record.

Each record in the array contains the following fields:

Field name	Type	Description
url	String	URL of the service endpoint (with "https://" protocol in the beginning and "/" in the end). Append the names of API calls to this URL.
token	Integer	Authentication token for the service.
priority	Integer (0..65535)	Priority of this host. A client must attempt to contact the target host with the lowest-numbered priority it can reach. Target hosts with the same priority should be tried in pseudorandom order.
weight	Integer (0..65535)	For load balancing. When selecting a target host among those that have the same priority, the chance of trying this one first should be proportional to its weight. Larger weights SHOULD be given a proportionately higher probability of being selected.

epsiDownloadURLs

array

Provides URLs with downloadable packages for EPSI (Erply point of sale integrator) installation. Provides a record per each operating system with installation link.

Each record in the array contains the following fields:

Field name	Type	Description
operatingSystem	String	Possible values - "Windows", "macOS" and "Linux"
url	String	Installation link