Integration mit API (REST)

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.