Zum Hauptinhalt springen
Die Data API ist eine REST-API, die auf den Remote-Servern von Kameleoon gespeicherte Daten abruft oder schreibt. Verwenden Sie die verfügbaren Endpoints, um:
  • Besuchsereignisse für einen bestimmten Besucher abzurufen.
  • Zusätzliche Besuchsereignisse für einen bestimmten Besucher zu senden, wie zum Beispiel Offline-Konversionsereignisse.
  • Produktdaten für einen bestimmten Sitecode zu senden und abzurufen.
  • Zusätzliche Daten für einen bestimmten Besucher zu speichern, wie zum Beispiel CRM- oder Segmentierungsdaten.

Data-API-Endpoints

Die Endpoints lassen sich in drei Hauptkategorien von Daten einteilen:

Visit-Endpoints

Die Visit-Endpoints rufen Ereignisse (Conversions, Custom Data, Segmente und mehr) für einen bestimmten Besuchercode ab und senden sie. Verwenden Sie diese Endpoints, um Offline-Kaufdaten, wie zum Beispiel Einkäufe im stationären Handel, in Kameleoon zu importieren.
  • GET /visit/visitor: Dieser Endpoint ruft die von Kameleoon erfassten Besuchsdaten ab, wie zum Beispiel Experimente und Personalisierungen, die für den Benutzer ausgelöst wurden, oder gezielte Segmente.
Der Zugriff auf diesen Endpoint erfordert die Kameleoon-Lösung Feature Experimentation. Für weitere Details kontaktieren Sie den Customer Success Manager.
  • POST /visit/forget: Dieser Endpoint entfernt Daten für mehrere Besucher.
  • POST /visit/events: Dieser Endpoint sendet Daten für einen bestimmten Besucher, wie zum Beispiel Konversions- und Seitenaufruf-Ereignisse.

Product-Endpoints

Die Product-Endpoints rufen Produktdaten für einen bestimmten Sitecode ab und senden sie. Verwenden Sie diese Endpoints, um produktbezogene Ereignisse wie Ansichten, Hinzufügen zum Warenkorb oder Kaufereignisse zu registrieren oder um Statistiken zu bestimmten Produkten zu erhalten (z. B. historische Kauf- oder Aufrufzahlen).
  • POST /product/events: Dieser Endpoint sendet Attribute (Name, Preis usw.) und Ereignisse (Ansicht, Hinzufügen zum Warenkorb, Kauf) für mehrere Produkte. Die Activation API verwendet die Methoden obtainProductData und obtainProductInteractions, um diese Daten abzurufen und für Targeting oder Empfehlungen zu verwenden.
  • GET /product/productCounters: Dieser Endpoint ruft Zählwerte (Anzahl der Aufrufe, Mengen im Warenkorb, Transaktionsmengen) für mehrere Produkte ab.
  • GET /product/productData: Dieser Endpoint ruft Attribute für mehrere Produkte ab.
Der Zugriff auf das Product Recommendation-Modul oder das Product Targeting-Add-on ist erforderlich. Beide lassen sich in die Lösung Web Experimentation integrieren. Weitere Informationen erhalten Sie vom Customer Success Manager.

Map-Endpoints

Die Map-Endpoints speichern zusätzliche Daten für einen bestimmten Schlüssel (in der Regel ein Besuchercode oder eine interne User-ID). Die Activation API und alle SDKs verwenden die Methode retrieveDataFromRemoteSource, um diese Daten abzurufen und für Targeting und Segmentierung zu verwenden. Verwenden Sie den map-Endpoint, um gespeicherte Daten für einen bestimmten Schlüssel abzurufen.
  • GET /map/map: Dieser Endpoint ruft Daten für einen bestimmten Schlüssel ab.
  • GET /map/maps: Dieser Endpoint ruft Daten für mehrere Schlüssel ab.
  • POST /map/maps: Dieser Endpoint sendet Daten für mehrere Schlüssel.

Authentifizierung und Ratenbegrenzung

Authentifizierung

Die Data API verwendet denselben Authentifizierungsfluss wie die Automation API unter Verwendung von JSON Web Tokens. Wahren Sie die Sicherheit und schützen Sie Ihre API-Anmeldedaten, indem Sie die Authentifizierung für bestimmte Anfragetypen verwenden:
  • Serverseitige Quellen: Für Anfragen, die von Ihren Servern stammen, wird die Authentifizierung dringend empfohlen und erhöht die Ratenbegrenzungen. Authentifizieren Sie sich, wenn Sie serverseitige SDKs mit Feature Experimentation verwenden.
  • Clientseitige Quellen: Für Anfragen, die von einer Clientanwendung wie einem Webbrowser stammen, bei denen API-Anmeldedaten offengelegt werden könnten, sollten Sie sich nicht authentifizieren. Diese Konfiguration wird bei der Verwendung von Kameleoon Web Experimentation nicht empfohlen.
Jede Anfrage, die ein API-Token mit falschem Format, ein abgelaufenes Token oder eine ungültige Signatur bereitstellt, führt zu einer HTTP-401-Antwort „Unauthorized”. Weitere Informationen zum Authentifizierungsprozess finden Sie in der Dokumentation Automation API Authentication Flow.
Standardmäßig ist keine Authentifizierung erforderlich, da die Data API die Web-Experimentation-Engine beim Abrufen historischer Daten unterstützt. Wenn Sie ausschließlich Feature Experimentation und serverseitige SDKs verwenden, kontaktieren Sie den Customer Success Manager, um die Authentifizierung für bestimmte Endpoints zu aktivieren. Kameleoon bietet eine flexible Einrichtung, um Endpoints zu sichern und die Authentifizierung auf GET- oder POST-Anfragen zu beschränken.

Ratenbegrenzungen

Die Data API erzwingt Ratenbegrenzungen basierend auf Ihren vertraglich vereinbarten monatlichen Unique Visitors (MUV) und der IP-Adresse des Anforderers. Wenn Ihre Anwendung eine dieser Grenzen überschreitet, gibt die API eine HTTP 429-„Too Many Requests”-Antwort zurück. Diese Ratenbegrenzungen sind vorhanden, um sicherzustellen, dass der Kameleoon-Service für alle Kunden leistungsfähig und zuverlässig bleibt. Für serverseitige Quellen können die IP-basierten Begrenzungen durch Authentifizierung aufgehoben werden.
AnfragetypLimits für alle AnfragenZusätzliche Limits, die nur für nicht authentifizierte Anfragen gelten
GET-Anfragen(500,000 + Anzahl der MUV) / 500 Anfragen pro Minute pro Kundenkonto120 Anfragen pro Minute pro IP
Andere HTTP-Methoden(500,000 + Anzahl der MUV) / 50 Anfragen pro Minute pro Kundenkonto (pro Methode)1,200 Anfragen pro Minute pro IP (pro Methode)
Wenn Sie für Ihren Anwendungsfall höhere Ratenbegrenzungen benötigen, wenden Sie sich bitte an Ihren Account Manager, um weitere Informationen zu erhalten.