API Integration

Neben der Nutzung der bestehenden Plugins für die Suche über Speedfinder.de besteht alternativ die Möglichkeit auf einfache Art und Weise eine eigene Integration der Suche umzusetzen. 

Diese Integration besteht aus zwei Teilen:

1. Erstellung eines Produktdaten-Feeds
2. Anbindung der Such-API

 

Produktdaten-Feed

Der Produktiondaten-Feed ist eine TabStopp getrennte Textdatei mit allen Produkten, die Sie in Ihrem Shop anbieten.

Dateiformat

• Die Daten müssen in einer TAB-separierten Datei (TSV) angeliefert werden. Erlaubte Dateiendungen sind .tsv und .csv, sowie .zip, falls die Datei gezipped geliefert wird. Mit Ausnahme des Zeichens ~, darf die Datei beliebig benannt werden.
• Grundsätzlich ersetzen die Daten aus einer Datei die Vorherigen vollständig. Ausnahme: Der Dateiname enthält das Wort Update. In diesem Fall werden die vorhandenen Daten aktualisiert. Wir empfehlen aber für diesen Zweck die API zu nutzen.
• Als Zeichenkodierung muss UTF8 verwendet werden.
• Als Dezimaltrenner muss ein Komma verwendet werden.
• Boolsche Werte müssen als 0 oder 1 exportiert werden.

Dateiaufbau

• Die erste Zeile enthält die Attributnamen.
• Die darauffolgenden Zeilen enthalten die Werte, diese dürfen nicht von Anführungszeichen o.ä. umschlossen sein. Für den unwahrscheinlichen Fall, dass Ihre Daten Tabs enthalten, müssen diese vorher durch Leerzeichen ersetzt werden.
• Es muss mindestens das Attribut 'ArtikelNr' gefüllt sein, alle anderen Attribute sind optional.
• Neben den vorgegebenen Attributen, darf die Datei auch kundenspezifische Attribute/Daten enthalten, sog. Zusatzattribute. Diese werden nicht indiziert, finden also bei der Suche keine Berücksichtigung (dafür stehen die Attribute Frei01-Frei05 zur Verfügung). Für Zusatzattribute können Facets erstellt werden, um z.B. bei der After-Search-Navigation darauf zu filtern. Zusatzattribute die mehrere Werte annehmen können, müssen mit dem Suffix '_Array' im Attributnamen exportiert werden. Die Attributwerte müssen durch '|' getrennt werden.
  Beispiel: Attributname in der ersten Zeile: 'Farbe_Array', Werte: 'Schwarz|Gelb'
  Es wird empfohlen, zunächst nur Werte für die vorgebenen Spalten zu exportieren um sicherzustellen, dass der Import grundsätzlich funktioniert.

Sonstiges

Nach dem Hochladen der Datei dauert es bis zu fünf Minuten, bis diese zur Verarbeitung aus Ihrem Ordner verschoben wird. Bitte beachten Sie außerdem, dass Ihre Datei danach evtl. nicht sofort verarbeitet wird, da sich noch andere Dateien in der Warteschlange befinden können.

Eine detaillierte Beschreibung des Aufbaus der Datei finden Sie unter foglendem Link: http://api.speedfinder.de/Help/FileImport

 

Such-API

Der zweite Teil nachdem Sie Ihre Produkte über den Produktdaten-Feed an den Speedfinder.de übertragen haben ist die Anbindung der Such-API um die Produkte anhand eines Suchworts und optionaler weitere Kriterien zu suchen.

Eine detaillierte Beschreibung der Such-API finden Sie unter folgendem Link: http://api.speedfinder.de/help