app - WEBSALE APP - WEBSALE Dokumentation

The app node covers all configurations for connecting and controlling the WEBSALE APP.
This section defines central app parameters such as the activation status, authentication, notification settings and the associated service accounts. The configuration can be made directly in the Admin Interface under Settings → Shop configuration → “App” group or via the REST API configuration.

`app*` - Basic structure

The basic structure of the app node is shown below:

{
  "app": {...},
  "googleServiceAccount": {...},
  "instances": {...}
}

Parameter overview

Parameter	Description
`app`	Controls the connection and behaviour of the WEBSALE APP (activation, token validation, connection data, limits).
`googleServiceAccount`	Defines the connection to a Google service account, e.g. for sending push messages.
`instances`	Defines individual app instances (e.g. per country, brand or channel).

`app.app` - WEBSALE APP configuration

The app node controls the connection and behaviour of the WEBSALE App. Among other things, it specifies whether the app integration is active, how tokens are validated, which shop connection data is used and which data and filter limits apply.

Example configuration

{
  "active": false,
  "applicationId": "",
  "enableTokenValidation": true,
  "filterLimits": {
    "maxEmailListSize": 500000,
    "maxZipCodeListSize": 50000,
    "maxZipCodeRangeSize": 5000
  },
  "googleServiceAccount": null,
  "imageFormats": null,
  "notificationSettings": {
    "defaultSettings": {
      "basketReminder": "undefined",
      "birthdayGreetings": "undefined",
      "deliveryNotification": "undefined",
      "news": "undefined",
      "teaser": "undefined"
    },
    "personalizedMessages": {
      "basketReminder": false,
      "birthdayGreetings": false,
      "deliveryNotification": false
    },
    "pushNotificationBatchSize": 500
  },
  "secret": "",
  "v8": null
}

Parameter overview

Parameter	Type	Description
`active`	bool	Enables (`true`) or disables (`false`) the WEBSALE APP. Default: `false`
`applicationId`	string	Unique identifier of the app (application ID).
`enableTokenValidation`	bool	Enables (`true`) or disables (`false`) token validation for app access. Default: `true`
`filterLimits`	object	Limits for app-internal filter functions.
`maxEmailListSize`	uint	Maximum number of email addresses in a filter list. Default: `500000`
`maxZipCodeListSize`	uint	Maximum number of postal codes in a filter list. Default: `500000`
`maxZipCodeRangeSize`	uint	Maximum number of postal code ranges. Default: `5000`
`googleServiceAccount`	assoc	Reference to the configured Google service account (see the `app.googleServiceAccount` section).
`oAuthKey`	—	`authentication.googleOAuthKey.FCMKey`
`scopes`	—	https://www.googleapis.com/auth/firebase.messaging
`imageFormats`	list	Defines the image formats used in the app frontend (multiple assignments via `content.imageFormat`). → content - Catalogue (categories & products)
`notificationSettings`	object	Settings for default and personalised push notifications.
`defaultSettings`	object	Default values for notification types (e.g. basket reminder, delivery status) when the app starts.
`basketReminder`	enum	Enables (`true`) or disables (`false`) the notification for abandoned baskets.
`birthdayGreetings`	enum	Enables (`true`) or disables (`false`) the birthday notification. To send birthday notifications, the recipient must have specified a date of birth.
`deliveryNotification`	enum	Default for shipping/delivery notifications.
`news`	enum	Default for newsletter notifications. Values: `undefined`, `enabled`, `disabled`
`teaser`	enum	Default for marketing messages.
`personalizedMessages`	object	Enables/disables personalised message types.
`basketReminder`	enum	Default for the reminder of abandoned baskets.
`birthdayGreetings`	enum	Default for birthday greetings.
`deliveryNotification`	enum	Default for shipping/delivery notifications.
`pushNotificationBatchSize`	uint	Number of push messages processed/sent in one batch. Example: `500`
`secret`	string	Secret key for validating tokens used for app communication.
`v8`	object	Optional detailed configuration for the connection to the V8 shop.
`osbAuth`	object	Credentials for OSB / backend communication of the app.
`username`	string	Technical user name for the OSB / backend connection.
`password`	string	Password for this technical user.
`shopId`	string	Identifier of the connected shop in the backend.
`shopUrl`	string	Base URL of the shop used by the app.
`shopPassword`	string	Password for the shop connection.
`personalizedDataFetchLimit`	uint	Maximum number of personalised records that may be loaded per fetch. Default: `500`
`voucherCodesFetchLimit`	uint	Maximum number of voucher codes that may be loaded per fetch. Default: `200`

`app.googleServiceAccount` - Push messages

The googleServiceAccount node defines the connection to a Google service account, for example for sending push messages.

Example configuration

{
  "oAuthKey": "authentication.googleOAuthKey.FCMKey",
  "scopes": [
    "https://www.googleapis.com/auth/firebase.messaging"
  ]
}

Parameter overview

Parameter	Type	Description
`oAuthKey`	singleAssoc	References a stored Google OAuth key that contains the credentials (key/JSON) of the service account. Target: `authentication.googleOAuthKey`
`scopes`	list (string)	List of OAuth scopes requested for the service account.

`app.instances` - APP instances

The instances node defines individual app instances of the WEBSALE App, typically per country, brand or channel. For each instance you can configure, among other things, base URLs, country information and deviating notification settings.

Example configuration `app.instances.deutsch`

{
  "base_url": "",
  "country": "",
  "country_code": "",
  "id": "",
  "label": "",
  "notificationSettings": {
    "defaultSettings": {
      "basketReminder": "undefined",
      "birthdayGreetings": "undefined",
      "deliveryNotification": "undefined",
      "news": "undefined",
      "teaser": "undefined"
    },
    "personalizedMessages": {
      "basketReminder": false,
      "birthdayGreetings": false,
      "deliveryNotification": false
    }
  },
  "shop_url": "",
  "v8": {
    "base_url": ""
  }
}

Parameter overview

Parameter	Type	Description
`base_url`	string	Base URL of the app instance.
`country`	string	Name of the country to which the instance is assigned.
`country_code`	string	Country code of the instance (e.g. `DE`, `AT`).
`id`	string	Unique identifier of the app instance (e.g. `de_shop`, `eu_shop`).
`label`	string	Readable name of the instance (e.g. “Germany shop”, “EU app”).
`notificationSettings`	object	Optional notification settings that can override the global app defaults.
`defaultSettings`	object	Defines the default settings for notifications in this instance.
`basketReminder`	bool	Enables/disables personalised basket reminders.
`birthdayGreetings`	bool	Enables/disables personalised birthday greetings.
`deliveryNotification`	bool	Enables/disables personalised delivery/shipping notifications.
`news`	enum	Default for newsletter notifications. Values: `undefined`, `enabled`, `disabled`
`teaser`	enum	Default for promotional messages.
`personalizedMessages`	object	Enables/disables certain personalised messages for this instance.
`basketReminder`	bool	Enables/disables personalised basket reminders.
`birthdayGreetings`	bool	Enables/disables personalised birthday greetings.
`deliveryNotification`	bool	Enables/disables personalised delivery/shipping notifications.
`shop_url`	string	URL of the associated online shop used in the app.
`v8`	object	Optional V8-specific configuration for this instance.
`base_url`	string	Base URL of the connected V8 shop instance for this app instance.

​app* - Basic structure

​Parameter overview

​app.app - WEBSALE APP configuration

​Example configuration

​Parameter overview

​app.googleServiceAccount - Push messages

​Example configuration

​Parameter overview

​app.instances - APP instances

​Example configuration app.instances.deutsch

​Parameter overview

`app*` - Basic structure

Parameter overview

`app.app` - WEBSALE APP configuration

Example configuration

Parameter overview

`app.googleServiceAccount` - Push messages

Example configuration

Parameter overview

`app.instances` - APP instances

Example configuration `app.instances.deutsch`

Parameter overview