Skip to main content
Die Product Recommendation API ist eine REST-API, die Ihren Produktkatalog in Kameleoon importiert und Ihrem Code personalisierte Produktempfehlungen und Suchergebnisse liefert. Die API ist für Projekte gedacht, die die Add-ons Product Recommendation und Search Personalization verwenden. Ihr Code bestimmt, wie jedes Produkt angezeigt wird, und Sie können jeden Aufruf mit Ihren eigenen Tools protokollieren und debuggen.

​
Funktionen der API

Die API umfasst vier Gruppen von Endpoints. Jede Gruppe deckt einen Teil einer Integration ab.
  • Initialisieren: Starten Sie eine Sitzung, um die Device-ID und die Session-ID zu erhalten, die Empfehlungs- und Suchanfragen verwenden.
  • Importieren: Laden Sie Kategorien, Produkte und Bestellungen hoch, aktualisieren Sie die Produktverfügbarkeit und entfernen Sie Produkte.
  • Empfehlen: Rufen Sie personalisierte Empfehlungen für einen Empfehlungsblock ab, rufen Sie eine Produktkollektion ab oder fordern Sie eine gefilterte Produktliste an.
  • Suche: Rufen Sie Sofort- oder vollständige Suchergebnisse für die Suchanfrage eines Besuchers ab.

​
Bevor Sie beginnen

  • Add-ons: Die API ist für Projekte gedacht, die die Add-ons Product Recommendation und Search Personalization verwenden.
  • Store Key: Sie finden ihn unter Recommendations > Settings > Store settings in der Kameleoon-App. Anfragen senden ihn als shop_id.
  • Secret Key: Sie finden ihn an derselben Stelle. Importanfragen senden ihn als shop_secret.
Wenden Sie sich bei Bedarf für einen der beiden Schlüssel an Ihren Customer Success Manager.

​
Katalog importieren

Empfehlungen stammen aus den Produkten in Ihrem Katalog. Importieren Sie deshalb Ihre Daten, bevor Sie Empfehlungen anfordern. Importieren Sie Kategorien, bevor Sie Produkte hochladen, damit der Produktimport aktuelle Kategorien verwendet. Verwenden Sie den Endpoint Import and update products für Kataloge mit mehr als 50.000 Produkten und vermeiden Sie tägliche vollständige Neuimporte des Katalogs. Für eine leichtere Änderung verwenden Sie den Endpoint Update available products, um die Verfügbarkeit vorhandener Produkte zu ändern. Jede Importanfrage enthält Ihren Secret Key im Anfragetext. Senden Sie Importanfragen deshalb von Ihrem Backend und nicht aus einem Browser oder einer App. Die vollständigen Importschritte finden Sie in der Anleitung zum Katalogimport.

​
So funktionieren Empfehlungsanfragen

Empfehlungs- und Suchanfragen verwenden zwei IDs: die Device-ID (did) und die Session-ID (sid). Bevor Sie einen anderen Endpoint aufrufen, rufen Sie Initialize session auf, um beide IDs zu erhalten.

​
Eine Sitzung initialisieren

Starten Sie eine Sitzung, um die Device-ID und die Session-ID zu erhalten, die Ihre anderen Anfragen benötigen. Senden Sie eine GET-Anfrage an https://api.products.kameleoon.com/init und übergeben Sie Ihren Store Key als Query-Parameter shop_id. Rufen Sie Initialize session je nach Plattform zu unterschiedlichen Zeitpunkten auf:
  • cURL: Jedes Mal, wenn Ihr Server die Seite rendert.
  • Web: Jedes Mal, wenn der Benutzer die Seite öffnet, auch in Single-Page-Anwendungen.
  • iOS und Android: Jedes Mal, wenn die App startet.
Rufen Sie beim ersten Start auf einem neuen Gerät Initialize session ohne Device-ID auf. Die API generiert eine Device-ID, und Sie verwenden sie für alle weiteren Anfragen. Wenn Sie die API mit Web Experimentation aus Ihrem Backend aufrufen, speichern Sie die Session-ID im Cookie KameleoonProducts_session_code und die Device-ID im Cookie KameleoonProducts_device_id.

​
Die Product Recommendation API in Postman testen

Testen Sie Anfragen an die Product Recommendation API ohne Code mit der Kameleoon-Product-Recommendation-API-Collection in Postman. Die Collection enthält eine Anfrage pro Endpoint.
  1. Laden Sie die Kameleoon-Product-Recommendation-API-Collection als ZIP-Archiv herunter, entpacken Sie die JSON-Datei und importieren Sie sie in Postman.
  2. Legen Sie im Tab Variables der Collection shopId auf Ihren Store Key und shopSecret auf Ihren Secret Key fest. Beide finden Sie in der Kameleoon-App unter Recommendations > Settings > Store settings.
  3. Senden Sie Initialize session. Die Anfrage speichert die Device-ID und die Session-ID in den Variablen did und sid, die die anderen Anfragen verwenden.
  4. Legen Sie recommenderCode oder collectionId für die Anfrage fest, die Sie testen möchten, und senden Sie sie dann.
Die Importanfragen ändern Ihren Produktkatalog. Prüfen Sie deshalb den Anfragetext, bevor Sie sie senden.

​
API-Referenz

Jeder Endpoint hat eine Referenzseite mit Parametern und Beispielen.

​
Anleitungen

Jede Anleitung führt Sie durch eine Aufgabe mit diesen Endpoints.