Zum Hauptinhalt springen
Die Kameleoon-Plattform bietet mehrere APIs, die Kunden für verschiedene Zwecke verwenden können. Diese APIs ermöglichen es Ihnen, Frontend-A/B-Experimente durchzuführen, Kameleoon durch das Abrufen und Senden von Daten in Ihr digitales Ökosystem zu integrieren, bestimmte Aufgaben wie das programmatische Erstellen oder Aktualisieren eines Experiments zu automatisieren und Ihren Produktkatalog zu importieren oder zu aktualisieren, wenn Sie die Add-ons Product Recommendation und Search Personalization verwenden. Kameleoon verfügt über vier Hauptgruppen von APIs: Dieser Artikel bietet einen Überblick auf hoher Ebene über diese APIs und hilft Entwicklern, schnell die benötigte API zu identifizieren und zur entsprechenden Dokumentation zu navigieren.

Die Activation API

Die Activation API ist eine JavaScript-API, die mit der Kameleoon-Anwendungsdatei engine.js (zuvor kameleoon.js genannt) geliefert wird. Diese wird auf Ihrer Website installiert, wenn Sie Kameleoon Web Experimentation oder Kameleoon im Hybrid-Modus für Feature Experimentation verwenden. Mit dieser API können Sie ihre Methoden direkt über JavaScript aufrufen und auf verschiedene Datenstrukturen zugreifen. Zusätzlich bietet sie den Kameleoon Conversion Score (KCS) – unseren echtzeitbasierten, kundenorientierten Propensity-Score – der mit unserem AI Predictive Targeting-Add-on verfügbar ist. Diese API erfüllt mehrere Zwecke:
  • Stellt Methoden zur Implementierung von Frontend-A/B-Testing-Variationen ohne Flackern bereit. Diese Methoden sind entscheidend, um das ordnungsgemäße Funktionieren der Kameleoon-Plattform sicherzustellen und ihre Anti-Flackering-Technologie zu nutzen. Alle Frontend-Entwickler, die mit Kameleoon arbeiten, sollten mit ihnen vertraut sein.
  • Stellt Tracking-Methoden zum Senden von Daten an Kameleoon bereit, wie zum Beispiel Konversionsdaten oder Besucher-/Kundeneigenschaften. Diese Methoden funktionieren ähnlich wie die von Analyselösungen wie Google Analytics. Sie können sie direkt über eingebettetes JavaScript in Ihren HTML-Seiten oder über einen Tag Manager wie Google Tag Manager (GTM) aufrufen. Wir empfehlen Ihnen außerdem, unsere Dokumentation zur Kameleoon CommandQueue zu lesen.
  • Stellt Methoden zum Verfolgen produktbezogener Ereignisse bereit, wie zum Beispiel Produktansichten und -käufe, das Hinzufügen von Produkten zum Warenkorb, das Abrufen automatischer Produktempfehlungen und das Abrufen produktspezifischer Statistiken für Anwendungsfälle wie Social Proof und Dringlichkeit.
  • Stellt nützliche Echtzeitinformationen bereit, die von Kameleoon gesammelt werden. Sie können beispielsweise die Seitenaufrufe eines Besuchers verfolgen, wobei die Daten gespeichert und über alle vorherigen Besuche hinweg zugänglich sind. Sie können auch feststellen, wie lange ein Besucher bei seinem ersten Besuch auf Ihrer Website verweilt hat, selbst wenn er sich derzeit bei seinem fünften Besuch befindet.
  • Stellt Einstiegspunkte bereit, um die Standard-Bucketing-Logik von Kameleoon zur Zuweisung zu überschreiben. Wenn ein Besucher beispielsweise zum ersten Mal einem A/B-Experiment zugewiesen wird, wird seine Variation zufällig bestimmt. Mit der API können Sie diese Zuweisung überschreiben und den Besucher in eine bestimmte Variation einschreiben.
Da die Activation API vollständig JavaScript-basiert ist, ist Skalierbarkeit kein Problem. Fast alle ihre Methoden (mit Ausnahme derer, die einen Serveraufruf erfordern, wie die produktkatalogbezogenen Funktionen) werden synchron ausgeführt und kehren sofort zurück. Für diese API ist keine Authentifizierung erforderlich, und Standard-Browserarchitektur sowie Sicherheitsprotokolle stellen sicher, dass Besucher nur auf ihre eigenen Daten (im Local Storage gespeichert) und nicht auf die Daten anderer Besucher zugreifen können.
Die Activation API ist hier vollständig dokumentiert. Sie finden auch eine separate Anleitung zu benutzerdefinierten JavaScript-Kameleoon-Events.

Die Automation API

Die Automation API ist eine REST-API, mit der Sie nahezu jede Aktion, die über unsere Kameleoon App verfügbar ist, programmatisch auslösen und ausführen können. Dadurch können Sie Ihre eigene Software entwickeln, um mit unserer Plattform zu interagieren und alle ihre Funktionen und Möglichkeiten zu nutzen. Einige unserer Kunden haben diese API beispielsweise verwendet, um Kameleoon mit ihren Git-Repositories zu integrieren, was ihnen ermöglicht, den Variation-Code von Kameleoon direkt in ihrem Versionskontrollsystem zu verwalten. Sie können auch ein benutzerdefiniertes Dashboard entwerfen und Experimentergebnisse direkt von Kameleoon abrufen. Diese API ist einfach zu verwenden, sodass sich mühelos benutzerdefinierte Systeme erstellen lassen, die mit Kameleoon arbeiten oder eine Schnittstelle zu Kameleoon bilden.
Diese API folgt REST-Prinzipien und ermöglicht es Ihnen, sie mit jedem REST-fähigen Framework in jeder Sprache (Java, C#, NodeJS, Python usw.) aufzurufen. Wir halten uns an REST-Konventionen, sodass jeder mit ihnen vertraute Entwickler sie leicht verwenden kann. Die API ist nicht für eine umfangreiche Nutzung gedacht. Sie sollte nur ein Dutzend Mal pro Minute pro Kunden-/Benutzerkonto auf unseren Systemen aufgerufen werden. Sie ist nicht auf Millionen von Aufrufen pro Minute skalierbar und sollte nicht für jeden Besucher Ihrer Website aufgerufen werden. Wenn Sie Datenzugriff mit hohem Volumen benötigen, lesen Sie die Data API für weitere Informationen.
Wir bieten eine VS Code-Erweiterung, die unsere Automation API nutzt. Weitere Informationen finden Sie in unserer Dokumentation.
Die Automation API ist hier vollständig dokumentiert.

Die Data API

Die Data API ist eine REST-API, die das Abrufen und Schreiben von Daten ermöglicht, die auf entfernten Servern gespeichert sind, anstatt lokal im Browser des Besuchers. Im Gegensatz zur Activation API, bei der Daten sofort auf der Browserseite verfügbar sind, ist diese API für die Kommunikation mit externen Datenquellen, entfernten Servern oder DMPs konzipiert. Im Gegensatz zur Automation API kann sie jedoch Millionen von Aufrufen pro Minute verarbeiten und ist daher für Anfragen auf Besucherebene geeignet. Die Data API wird beispielsweise für die geräteübergreifende Verlaufsabstimmung verwendet, eine leistungsstarke Kameleoon-Funktion, die automatisch den vollständigen Aktionsverlauf eines Unique Visitors über alle seine Geräte hinweg synchronisiert. Wenn ein Besucher Ihre Website zweimal mit seinem Smartphone besucht und später auf seinem Desktop-Computer zurückkehrt, melden wir dies in der Datenebene der Activation API korrekt als dritten Besuch. Im Hintergrund führen unsere Server einen Aufruf der Data API durch, um die Datensynchronisation zu gewährleisten. Ein weiterer häufiger Anwendungsfall ist das Registrieren „später Transaktionen”, die nicht direkt über die Activation API gesendet werden können. Wenn Ihr Unternehmen beispielsweise Reisepakete verkauft und die endgültige Transaktion oder Bestätigung persönlich in einem physischen Geschäft anstatt online erfolgt, können Sie diese API verwenden, um diese Transaktionen aufzuzeichnen – etwas, das mit einer Web-/JavaScript-basierten API unmöglich wäre. Die Data API ist eine REST-konforme API, was bedeutet, dass sie mit jedem REST-fähigen Framework in jeder Sprache, wie Java, C#, NodeJS oder Python, aufgerufen werden kann. Wir halten uns an REST-Konventionen, sodass sie für Entwickler, die mit ihnen vertraut sind, einfach zu verwenden ist. Die Data API ist hier vollständig dokumentiert.

Die Product Recommendation API

Die Product Recommendation API ist eine RESTful-API, die eine effiziente Verwaltung Ihres Produktkatalogs ermöglicht und das Abrufen personalisierter Produkt- und Suchempfehlungen erleichtert. Diese API ist besonders vorteilhaft für Kunden, die die Empfehlungslogik in ihren eigenen Backend-Systemen oder mobilen Anwendungen verwalten möchten. Diese API erfüllt mehrere Zwecke:

Verwaltung des Produktkatalogs

Die folgenden Endpoints sollten verwendet werden, um Ihren Produktkatalog zu importieren und zu aktualisieren:

Produkt- und Suchempfehlungen