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.


Für die Integration über die REST-API gibt es zwei Möglichkeiten:

1. Code, der direkt über HTTP oder über dafür vorgesehene Tools über HTTP mit der REST-API des FactFinders kommuniziert. Alle dafür notwendigen Informationen sind auf der Swagger-ui Seite Ihres FactFinders zu finden : https://[your fact-finder setup here]/fact-finder/swagger-ui.html . Unter https://github.com/FACT-Finder sind Demos und Beispiele zu finden.

2. Die Verwendung von Swagger-Codegen. Auf diese Art werden Klassen wie zum Beispiel SearchRequest, SearchParams und TrackingApi automatisch generiert. Dies vereinfacht den Code, der für die Integration des FactFinders in den Shop geschrieben werden muss. Informationen über diese Art der der Integration sind hier zu finden: .Die Verwendung von Swagger Codegen für die Integration über API vNGAscent