Integration über API (REST)

Erstellen Sie eine serverseitige REST-Integration für FactFinder Search und zeigen Sie Suchergebnisse in Ihrem Shop an.

Das folgende Diagramm zeigt die API-basierte Integration auf hoher Ebene:

Vorbereitungen und Design

Die serverseitige Integrationsschicht sitzt zwischen dem FactFinder Search-Server und Ihren Shop-Seiten. Sie übernimmt die Kommunikation zwischen den beiden Systemen. Erstellen Sie diese Schicht, bevor Sie mit der API-Integration beginnen.

Die Schritte sind wie folgt:

1. Senden Sie die Suchanfrage an FactFinder. Die vom Benutzer eingegebenen Suchparameter müssen per HTTP-Anfrage an den FactFinder Search-Server gesendet werden.
2. Empfangen Sie die Suchergebnisse. Der FactFinder Search-Server gibt die Ergebnisse in einer strukturierten Antwort wie XML oder JSON zurück.
3. Verarbeiten Sie die Suchergebnisse. Ihr Shopsystem muss die zurückgegebenen Daten parsen.
4. Rendern Sie die Suchergebnisseite. Die Seitenstruktur sollte auf den zurückgegebenen Suchergebnisdaten basieren.

Der Hauptunterschied zu einer Web-Components-Integration besteht darin, dass Ihr Shop die Suchergebnisseite selbst rendert. Dadurch bleibt das Design an einem Ort und lässt sich leichter warten.

Integrationsmöglichkeiten

Die Integration per API gibt es in zwei Varianten:

1. Entwickeln Sie den Integrationscode von Grund auf. Alle erforderlichen Informationen finden Sie in Ihrer Swagger UI unter https://[your FactFinder setup here]/FactFinder/swagger-ui.html. Außerdem finden Sie Demos und Beispiele auf GitHub.
2. Verwenden Sie Swagger Codegen. Es generiert Klassen wie SearchRequest, SearchParams, und TrackingApi automatisch, was Ihren Integrationscode vereinfacht. Erfahren Sie mehr in Wie Sie Swagger Codegen für die Integration über die API verwenden.