Der generelle Ablauf einer Integration über APIs ist identisch, folgendes Schaubild versucht diesen zu verdeutlichen:

Mit Serverscript ist eine Anwendung oder Code gemeint, der zwischen dem FactFinder-Suchserver und den Ausgabeseiten platziert ist und die Kommunkation zwischen diesen regelt. Genau dieser Teil muss bei einer API-Integration erstellt werden.

In Worten handelt es sich um folgende Schritte:

1. Übermittelung der Suchanfrage an FactFinder: Die Suchparameter, die vom Benutzer in das Suchfeld eingegeben wurden (Query), müssen an den FactFinder-Suchserver weitergereicht werden (Request).
2. Empfangen des Suchergebnisses (Response): Der FactFinder-Suchserver übergibt die dem Serverscript das Suchergebnis über eine API oder einem definierten Datenformat.
3. Verarbeiten des Suchergebnisses: Die Response muss im Anschluss vom Serverscript geparst und interpretiert werden.
4. Generieren der Suchergebnisseite (Display): Auf Basis der gelieferten Suchergebnisinformationen muss die HTML-Darstellung der Suchergebnisseite aufgebaut werden.

Der wichtigste Unterschied dieser Methode zur Web Components-Rückgabe ist, dass das Design der Suchergebnisseite vom Shop erstellt wird. So wird das Design zentral verwaltet und muss nicht an mehreren Stellen gewartet werden.

XML und JSON

Bei der Integration über die XML- und JSON-Schnittstelle werden die Suchparamater in Form einer URL vom Shop an den FactFinder-Suchserver übergeben. FactFinder antwortet auf diese Anfrage in einem spezifizierten Datenformat (XML oder JSON), das alle Informationen enthält, die notwendig sind, um eine Suchergebnisseite aufzubauen.

Für beide Varianten existieren Schemadefinitionen, die das Rückgabeformat spezifizieren.

REST

Ab der FactFinder Version 7.3 steht Ihnen auch eine richtige REST-Schnittstelle für die API-Integration zur Verfügung, diese lässt sich am besten mit der XML und JSON-API vergleichen, da sie auch beide Dateiformate zurückliefern kann.

Webservice / SOAP