Overview

Die gesamte Kommunikation mit der KI von Clerk.io erfolgt über unsere superschnelle REST API.

Unabhängig von der Webshop-Plattform kann Clerk immer entweder über die API oder mit unserer Clerk.js-Lösung integriert werden, die API-Aufrufe vom Frontend ausführt.

Anschließend entwickeln wir Erweiterungen und Integrationen, die Funktionen aus der API und Clerk.js bündeln, um die Integration auf jeder Plattform reibungslos zu gestalten.

API #

Dies ist das Herzstück der Funktionalität von Clerk.io. Sie ist unter dieser URL erreichbar:

https://api.clerk.io/v2

Die Kommunikation mit der API erfolgt mittels API-Schlüsseln und einer Reihe verschiedener Endpunkte, die Daten im JSON-Format zurückgeben.

Call

curl --request POST \
     --url 'https://api.clerk.io/v2/recommendations/trending' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
     -d '{"key": "insert_api_key",
          "limit": 3,
          "labels": ["Homepage - Trending"]
        }'

Response

{
    "status": "ok",
    "result": [
        12793,
        13827,
        12693
    ],
    "count": 3902,
    "facets": null
}

Für die Einrichtung dieser Kommunikation müssen Sie Daten synchronisieren, Ergebnisse abrufen, diese visualisieren und ein Tracking hinzufügen. Alle Details finden Sie im API guide.

Clerk.js #

Diese JavaScript-Bibliothek vereinfacht die Integration der Dienste von Clerk.io in jedes Frontend.

Clerk.js übernimmt sämtliche Aufgaben wie Netzwerk-Anfragen, das elegante Handling von Fehlern, das Rendern in den DOM und das Anwenden von Tracking automatisch.

<!--Clerk.js script-->
<script type="text/javascript">
  (function(w,d){
    var e=d.createElement('script');e.type='text/javascript';e.async=true;
    e.src='https://cdn.clerk.io/clerk.js';
    var s=d.getElementsByTagName('script')[0];s.parentNode.insertBefore(e,s);
    w.__clerk_q=w.__clerk_q||[];w.Clerk=w.Clerk||function(){ w.__clerk_q.push(arguments) };
  })(window,document);

  Clerk('config', {
    key: 'insert_api_key'
  });
</script>

<!--Recommendations snippet-->
<span class="clerk" data-template="@bestsellers"></span>

Für die Einrichtung von Clerk.js müssen Sie die Tracking-Skripte einfügen, Designs erstellen und Snippets in Ihr Frontend einbauen. Alle Details sind im Getting Started guide beschrieben.

Erweiterungen #

Diese werden als Pakete in die Plattform installiert, die Datenfeeds, API-Aufrufe und Clerk.js bündeln. Sie übernehmen die Synchronisierung, das Tracking und das Einfügen von Snippets. Beispiele sind:

• Magento2
• WooCommerce
• Prestashop

Da die Erweiterung auf Ihrem Server installiert wird, können Sie diese im Code beliebig erweitern oder ändern. Stellen Sie lediglich sicher, dass Ihre Änderungen getrennt von den Core-Dateien erfolgen, um diese beim Update auf eine neue Version nicht zu überschreiben.

Die meisten Erweiterungen synchronisieren die Daten, indem sie Endpunkte auf dem Webshop erstellen, auf die dann mit den Public- und Private-Keys zugegriffen wird.

Wenn Sie eine Datensynchronisierung ausführen, ruft der Importer von Clerk jeden Endpunkt ab, um die Daten im JSON-Format per Pagination zu erhalten:

https://awesomestore.com/clerk/product?key=insert_public&private_key=insert_private&page=1&limit=100
https://awesomestore.com/clerk/category?key=insert_public&private_key=insert_private&page=1&limit=100
https://awesomestore.com/clerk/order?key=insert_public&private_key=insert_private&page=1&limit=100

Integrationen #

Diese nutzen die API der Webshop-Plattform zur Datensynchronisierung, wohingegen Snippets manuell in die Webshop-Dateien eingefügt werden müssen. Beispiele sind:

• Shopify
• BigCommerce
• Lightspeed

Integrationen werden auf den Servern von Clerk.io gehostet. Das bedeutet, dass Sie deren Code nicht ändern können, jedoch verschiedene Konfigurationsoptionen über die Data-Seite vorfinden.

Wenn wir eine Erweiterung oder Integration für Ihre Plattform haben, empfehlen wir, diese zu verwenden, um zumindest Teile der Installation zu vereinfachen.

Sie können diese auch ausschließlich für die Datensynchronisierung nutzen und anschließend die API oder Snippets für das Frontend verwenden. Betrachten Sie sie als Toolkits, die bestimmte Einrichtungsschritte erleichtern.

Auswahl Ihres Setups #

Die Integration mit Clerk.js ist oftmals am schnellsten und gibt den nicht-technischen Mitarbeitern Ihres Unternehmens nach der Integration mehr Kontrolle über das Setup.

Sie müssen sich außerdem keine Gedanken über Tracking und zusätzliche Serverlast machen, da Clerk.js im Frontend ausgeführt wird, während die Seite lädt.

API-Setups eignen sich am besten, wenn Sie umfangreiche, individuelle Business-Logik anwenden müssen.

Ein Beispiel: Wenn Sie einen B2B-Shop mit individuellen Preisen und Katalogen für jeden eingeloggten Kunden entwickeln, ist es einfacher, die API-Calls serverseitig durchzuführen und die Business-Logik nachdem Clerk die Ergebnisse liefert, anzuwenden.

Ein weiterer Anwendungsfall ist der Wechsel von einer anderen API zu Clerk. Hier ist es oft schneller, einfach die API-Aufrufe auszutauschen und die Parameter umzuschreiben, als eine Clerk.js-Installation durchzuführen.

Wenn Sie eine App entwickeln, ist die Verwendung der API in der Regel der beste Weg, um diese mit Clerk.io zu verbinden – und meistens die einzige Möglichkeit, wenn die App kein JavaScript unterstützt.