storefrontApi - Storefront-API

Der storefrontApi-Knoten bündelt alle Konfigurationsmöglichkeiten der Storefront-API im WEBSALE Shopsystem für die Anbindung externer Frontends.

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"
}

​

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)

---

​

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.