JSON vs. XML API

by | Mrz 11, 2020 | 0 comments

Was beinhaltet die Findologic JSON-API? Welche Vorteile bietet JSON vs. XML API?

JSON API:

  • Die JSON API enthält dieselben Informationen wie die XML API (Filter, Pagination), aber darüber hinaus auch sämtliche zur Darstellung der Suchergebnisse benötigten Informationen (Name, Preis, Bild, Link, …)
  • Weiterhin können pro Suchergebnis auch die Attribute (Brand=Adidas, Größe=XL, Farbe=rot, …) in der JSON API Response zurückgegeben werden
  • Die Suchergebnisse können also, nachdem die JSON API vom Shop angefragt wurde, direkt ausgegeben werden, ohne dass vorher noch zusätzliche Informationen von der Shop-Datenbank / ERP geholt werden müssen
  • Die Integration wird leichter, da es nicht mehr nötig ist, Informationen aus mehreren Quellen zu aggregieren
  • Aus dem gleichen Grund verbessert das die Performance; grob gesagt: Zeit bis die Suchergebnisse dargestellt werden können = Anfrage an JSON API + HTML Rendering

XML API:

  • Die XML API liefert zwar Informationen über Filter, Pagination etc. zurück, aber für die Suchergebnisse nur Produkt-IDs
  • Um die Suchergebnisse im Shop auszugeben, müssen daher noch weitere Informationen wie Name, Preis, Bild, Link von der Shop-Datenbank / ERP geholt werden
  • Das bringt zusätzlich zeitliche und finanzielle Aufwände bei der Integration mit sich, da Daten aus mehreren Quellen (FINDOLOGIC + Shop-Datenbank / ERP) aggregiert werden müssen
  • Einbußen bei der Performance, d.h. es dauert länger, bis die Suchergebnisse im Shop angezeigt werden; grob gesagt: Zeit bis die Suchergebnisse dargestellt werden können = Anfrage an XML API + Anfrage an Shop-Datenbank / ERP + HTML Rendering

Vorteil der JSON-API für Partneragenturen:

Der Vorteil unserer neuen JSON API für Agenturen liegt auf der Hand. Es spart nicht nur Zeit und Aufwand bei der Integration, sondern verbessert auch die Performance im Online-Shop. Somit können lange Ladezeiten verhindert und dem Shop-Betreiber zusätzlich Ressourcen gespart werden. Reagiert ein Online-Shop nämlich nicht erwartungsgemäß schnell, reduziert jede Sekunde Latenz die Conversion-Rate um bis zu 7%. Besonders negativ wirkt sich dies auf die Moblie Conversion aus.

Welchen Informationen werden via JSON API geliefert?

Folgende Informationen werden durch die JSON API ausgegeben:

  • Filter
  • Metadaten (Was war die Suchanfrage, ist Smart Did-You-Mean aktiv)
  • Pagination
  • Suchergebnisse inkl. fast aller Daten, die pro Produkt exportiert wurden:
    1.  ID
    2. SKUs
    3. Aktive Merchandising Regeln (Product Placement, Search-Concept, etc.)
    4. Preis
    5. Name
    6. Bild
    7. Link
    8. Attribute (brand=Adidas, Größe=XL, Farbe=rot, …)

Eine vollständige Dokumentation finden sie hier unter („FINDOLOGIC Search API JSON response 1.0“).
Innerhalb unseres interaktiven Swagger-Files kann die API auch direkt angesprochen und getestet werden (Shopkey vorausgesetzt)

Wie verhalten sich Headless – und API first Ansätze mit der JSON API?

Vor allem im E-Commerce geht der Trend immer mehr zu sogenannten Headless-Lösungen. Hier wird das komplette Shop-Frontend nur über Schnittstellen an das Shopsystem angebunden. Einfach gesprochen: Alles, was ein Besucher des Online-Shops. sieht, kommt nicht vom Shopsystem sondern aus einem offenen Frontend-System. Unsere JSON-API steht daher indirekt in Beziehung und ist insbesondere für Single-Page Apps (SPAs) interessant.

Diese sind zumeist in Javascript mit Angular, React oder Vue.js (siehe: Vue Storefront) geschrieben. Single-Page Apps schicken AJAX Requests über den Browser direkt an die entsprechende Datenquelle. Das hat den Vorteil, dass die JSON API alle benötigten Daten zum Darstellen der Suchergebnisse enthält, sodass bei einer Suchanfrage überhaupt kein Request mehr an den Shop geschickt werden muss.

Weiterhin ist JSON, im Gegensatz zu XML, ein besserer Match für Javascript,´. Javascript Storefronts verstehen JSON automatisch.

Zusammenhang zu Headless Commerce: Hierbei wird ohnehin ein unabhängiges Frontend aufgebaut, um den Shop erreichbar zu machen. Diese werden aller Voraussicht nach in Zukunft vielfach SPAs sein.

 Georg Sorst

Georg Sorst is CTO at FINDOLOGIC GmbH and was the first permanent employee of the company. He helped build both the team and the product from scratch. He gained his IT industry expertise and experience over many years with companies such as IBM as well as various start-ups. As a frequent guest and lecturer at conferences and events he ensures he remains technically up-to-date.  Georg is also a member of the Gesellschaft für Informatik.  What fascinates him about FINDOLOGIC is the constant challenges posed by the e-commerce market, in particular search technologies with their rapid developments and trends.

Mit dem Absenden des Formulars erlaube ich die Speicherung und Verarbeitung meiner Daten durch FINDOLOGIC, wie Sie in der Datenschutzerklärungbeschrieben ist.