storefrontApi - Storefront-API - WEBSALE Dokumentation

Der Knoten storefrontApi bündelt die Konfigurationsmöglichkeiten für die Storefront-API.

`storefrontApi*` - Grundstruktur

Nachfolgend der Grundaufbau des Knotens storefrontApi

{
  "storefrontApi": {
    "redirects": {},
    "catalogApiSettings": {}
  }
}

Parameterbeschreibung

Parameter	Beschreibung
`redirects`	Definiert Template-Weiterleitungen (`identifier` → Ziel-Template).
`catalogApiSettings`	Steuert die Katalog-Endpunkte der Storefront-API und die darüber auslieferbaren Felder.

`storefrontApi.redirects` - Template-Weiterleitung

Der Knoten storefrontApi.redirects definiert, welcher Name (identifier) auf welches Template im Shop verweist.

Beispielkonfiguration

{
  "identifier": "checkout",
  "targetTemplateName": "checkout.htm",
  "parameters": {
    "step": "1"
  }
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`identifier`	string	Freier Name der Weiterleitung, wird als `viewIdentifier` im API-Aufruf verwendet. Mehr dazu: Storefront API Session-Handling
`targetTemplateName`	string	Pfad/Name der Ziel-Template-Datei (z. B. `checkout.htm`)
`parameters`	object	Optionale Werte, die dem erzeugten Link als Query-Parameter angehängt werden. Im Template stehen sie wie alle URL-Parameter zur Verfügung, z. B. über `$wsViews.current.paramList`. Hierüber erhält eine mehrstufige Zielseite ihren Einstiegsschritt.

Mit der Beispielkonfiguration oben liefert session/prepareRedirect einen Link der Form:

https://ihr-shop.de/checkout?step=1&sessionKey=...

Die Werte aus parameters sind fest konfiguriert und für jeden Aufruf gleich. Werte, die je Aufruf unterschiedlich sind, übergeben Sie stattdessen im Request-Body von session/prepareRedirect — diese landen jedoch in der Session und nicht in der URL.

`storefrontApi.catalogApiSettings` - Steuerung der Katalog-Endpunkte

Der Knoten storefrontApi.catalogApiSettings steuert, welche Katalog-Endpunkte in der Storefront-API verfügbar sind und welche Felder darüber ausgeliefert werden dürfen.

Beispielkonfiguration

{
  "categoryFieldWhitelist": null,
  "enableCategoryDataEndpoint": true,
  "enableCategoryWhitelist": false,
  "enableProductDataEndpoint": true,
  "enableProductWhitelist": false,
  "productFieldWhitelist": null
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`enableProductDataEndpoint`	bool	Aktiviert/deaktiviert den Produkt-Endpunkt der Storefront-API.
`enableCategoryDataEndpoint`	bool	Aktiviert/deaktiviert den Kategorien-Endpunkt der Storefront-API.
`enableProductWhitelist`	bool	Schaltet eine Whitelist für auslieferbare Produktfelder ein. Wenn `true`, werden nur Felder aus `productFieldWhitelist` zurückgegeben. Default: `false`
`enableCategoryWhitelist`	bool	Schaltet eine Whitelist für auslieferbare Kategoriefelder ein. Wenn `true`, werden nur Felder aus `categoryFieldWhitelist` zurückgegeben. Default: `false`
`productFieldWhitelist`	multiAssoc	Liste erlaubter Produktfelder aus `content.productField` und/oder `content.customProductField`. Wirkt nur, wenn `enableProductWhitelist = true`.
`categoryFieldWhitelist`	multiAssoc	Liste erlaubter Kategoriefelder aus `content.categoryField` und/oder `content.customCategoryField`. Wirkt nur, wenn `enableCategoryWhitelist = true`.

​storefrontApi* - Grundstruktur

​Parameterbeschreibung

​storefrontApi.redirects - Template-Weiterleitung

​Beispielkonfiguration

​storefrontApi.catalogApiSettings - Steuerung der Katalog-Endpunkte

​Beispielkonfiguration

​Parameterbeschreibung

`storefrontApi*` - Grundstruktur

Parameterbeschreibung

`storefrontApi.redirects` - Template-Weiterleitung

Beispielkonfiguration

`storefrontApi.catalogApiSettings` - Steuerung der Katalog-Endpunkte

Beispielkonfiguration

Parameterbeschreibung