1. Darstellung von Inhalten in der Storefront
Nach der FirstSpirit-seitigen Erstellung oder Pflege redaktioneller Inhalte findet mit deren Speicherung oder Freigabe eine automatische Übertragung in den CaaS statt. Dieser persistiert die Inhalte und stellt sie über eine REST-Schnittstelle im JSON-Format bereit. Die Storefront nimmt diese Informationen entgegen und verknüpft sie mit denen des Shop-Systems, um sie in einer kombinierten Ansicht auszuliefern.
Die folgenden Punkte stellen die Aufgaben bei der Integration der Daten in die Storefront dar.
|
Im Folgenden wird auf das Frontend API-Server Modul verwiesen. Grundsätzlich kann der clientseitige Teil der Frontend API mit beliebigen Backends kommunizieren, solange das entsprechende API-Schema implementiert wurde. |
- Authentifizierung
-
Die Abfrage von Daten aus dem CaaS setzt einen API-Key voraus, welcher vor unerlaubten Zugriffen zu schützen ist. Er besitzt den Stellenwert eines Passworts und ist daher entsprechend zu behandeln. Andernfalls sind die im CaaS gespeicherten Inhalte frei zugänglich.
Bei Verwendung der Frontend API wird die Kommunikation mit dem CaaS vom Frontend API-Servermodul bzw. dessen Referenzimplementierung Frontend API Backend übernommen. Dieses Modul vewaltet den CaaS API-Key und sorgt so dafür, dass dieser dem Client nicht zugänglich gemacht werden muss. Gleichzeitig trifft dieses Modul die Unterscheidung zwischen dem Vorschau- und dem Freigabestand innerhalb des CaaS. Standardmäßig geschieht dies aufgrund der URL des ContentCreator, dieses Verhalten lässt sich jedoch anpassen.
- Zuordnung der Daten
-
Bei der Abfrage der redaktionellen Inhalte aus dem CaaS ist es wichtig, die richtigen Daten abzufragen. Aus diesem Grund ist darauf zu achten, dass sich die in FirstSpirit verwendeten Produkt- und Kategorieinformationen stets den realen Daten im Shop-System zuordnen lassen. Dafür ist ein Mapping erforderlich, das auf eindeutigen IDs basiert und bereits durch die Bridge vorgegeben sein muss. Die IDs werden ihrerseits in den Formulardaten eines FirstSpirit-Elements gespeichert und per Freigabe mit in den CaaS übertragen. Auf Basis der IDs ist damit sowohl eine Abfrage der im CaaS gespeicherten FirstSpirit-Daten als auch ihre Verknüpfung mit den Shopdaten möglich. Weitere Informationen werden im Detail in dem Unterkapitel Mapping der Identifier und Frontend API Backend beschrieben.
Bei Verwendung der Frontend API werden durch deren Serverkomponente Endpunkte bereitgestellt, welche das gezielte Abfragen von Inhalten aus dem CaaS anhand der für das Mapping verwendeten Merkmale anbietet.
- Transformation der Daten
-
Der CaaS speichert die an ihn übergebenen Daten im JSON-Format. Diese liegen in einer komplexen Schachtelung vor und sind teilweise für die Darstellung in der Storefront möglicherweise zu umfangreich. Für die weitere Verarbeitung der Daten kann es daher sinnvoll sein, im ersten Schritt eine Transformation durchzuführen. In diesem Schritt ist es empfehlenswert, die Daten auf das Wesentliche zu reduzieren und in ein für die Storefront optimales Format zu überführen. Außerdem ist darauf zu achten, dass verknüpfte Informationen, wie beispielsweise Medien-URLs, korrekt aufgelöst werden.
Das Servermodul der Frontend API löst diese URLs automatisch auf und erlaubt durch sein Plugin-Konzept die Transformation der Daten auf Serverseite.
- Ausgabe der Daten
-
Die Ausgabe der redaktionellen Inhalte übernimmt weiterhin die Storefront. Diese bezieht sie jedoch nicht mehr ausschließlich aus dem Shop-Backend, sondern zusätzlich aus dem CaaS. Die Storefront verknüpft die Daten miteinander, um sie in einer kombinierten Ansicht auszuliefern.
Genauso wie bei der Abfrage der Daten aus dem CaaS ist auch bei ihrer Ausgabe darauf zu achten, dass die in FirstSpirit verwendeten Informationen stets korrekt den realen Shop-Daten zugeordnet sind. Dies beinhaltet nicht nur die Darstellung der richtigen Inhalte, sondern auch deren korrekte Platzierung. Innerhalb des in der Auslieferung enthaltenen Referenzprojekts FirstSpirit Connect for Commerce Reference Project werden die editierbaren Bereiche einer Shopseite durch die Inhaltsbereiche (Slots) einer FirstSpirit-Seitenvorlage repräsentiert. Ihnen können Absätze hinzugefügt werden, die jeweils der äquivalenten Komponente einer Shopseite entsprechen. Dies ist bei der Ausgabe der redaktionellen Inhalte zu berücksichtigen und umzusetzen.
Für den Fall, dass es sich bei der Storefront um eine PWA handelt, bietet die Frontend API clientseitige Funktionen, welche die Daten anhand der im Mapping definierten Parameter direkt vom Server abfragt. Diese können dann clientseitig durch die PWA gerendert werden.
Wenn die Storefront die Seiten serverseitig generiert, werden die Inhalte in der Regel durch das Backend des Shop-Systems abgerufen.
Weitere Informationen zur Unterscheidung zwischen PWA und statischen Seiten sind in dem entsprechenden Kapitel der Hauptdokumentation beschrieben.
- Pflege des Inhalts in FirstSpirit
-
Damit die in FirstSpirit gespeicherten Inhalte über den ContentCreator redaktionell gepflegt werden können, muss Omnichannel Manager in der Storefront eingebunden und die zu pflegenden Bereiche speziell im HTML markiert sein. Weitere Informationen zur Bearbeitung von Seiten finden sich in dem entsprechenden Kapitel der Hauptdokumentation.
Die Verwendung des clientseitigen Teils der Frontend API Implementiert diese Funktion standardmäßig. Innerhalb der Storefront müssen dann nur die HTML-Elemente, welche die Inhaltsbereiche beinhalten sollen, gekennzeichnet werden.
- Erweiterung der Navigation
-
Während Shop-driven Pages in der Regel bereits standardmäßig in der Navigation der Storefront angezeigt werden, muss dies für FirstSpirit-driven Pages zunächst implementiert werden. Die Struktur von in FirstSpirit erstellten Seiten ist über den Navigation Service verfügbar. Mit ihr kann die Navigation der Storefront so erweitert werden, dass auch FirstSpirit-driven Pages angezeigt werden. Für die Implementierung einer Navigation sind entsprechend die relevanten Abfragen gegen den Navigation Service zu richten.
Die Frontend API unterstützt diese Integration durch eine Anbindung des Navigation Service in ihrem Servermodul analog zur CaaS-Anbindung. Die Storefront muss somit nicht selbst direkt mit dem Navigation Service kommunizieren, sondern erhält ihre Daten aus einer Quelle. Clientseitig stehen entsprechende Methoden bereit.
2. Rechtliche Hinweise
FirstSpirit Connect for Commerce ist ein Produkt der Crownpeak Technology GmbH, Dortmund, Germany.
Für die Verwendung des Moduls gilt nur die mit der Crownpeak Technology GmbH vereinbarte Lizenz.
3. Hilfe
Der Technical Support der Crownpeak Technology GmbH bietet qualifizierte technische Unterstützung zu allen Themen, die FirstSpirit™ als Produkt betreffen. Weitere Hilfe zu vielen relevanten Themen erhalten und finden Sie in auch in unserer Community.