Overview

Alle Kommunikationen mit der KI von Clerk.io erfolgen über unsere superschnelle REST-API.

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

Wir erstellen dann Erweiterungen und Integrationen, die Funktionen aus der API und Clerk.js bündeln, um die Integration für jede Plattform reibungslos zu gestalten.

API #

Dies ist das Fundament der Funktionalität von Clerk.io. Es ist unter dieser URL zugänglich:

https://api.clerk.io/v2

Sie kommunizieren mit der API mithilfe von API-Schlüsseln und einer Reihe von verschiedenen Endpunkten, die Daten im JSON-Format zurückgeben.

Aufruf

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"]
        }'

Antwort

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

Die Einrichtung dieser Kommunikation erfordert, dass Sie Daten synchronisieren, Ergebnisse abrufen, diese Ergebnisse visualisieren und Tracking hinzufügen. Alle Details sind im API-Leitfaden aufgeführt.

Clerk.js #

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

Clerk.js übernimmt die gesamte schwere Arbeit, wie das Tätigen von Netzwerk-Anfragen, das elegante Handhaben von Fehlern, das Rendern in das DOM und das Anwenden von Tracking sofort.

<!--Clerk.js-Skript-->
<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>

<!--Empfehlungen-Snippet-->
<span class="clerk" data-template="@bestsellers"></span>

Die Einrichtung von Clerk.js erfordert, dass Sie die Tracking-Skripte einfügen, Designs erstellen und Snippets in Ihr Frontend hinzufügen. Alle Details sind im Getting Started-Leitfaden aufgeführt.

Erweiterungen #

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

• Magento2
• WooCommerce
• Prestashop

Da die Erweiterung auf Ihrem Server installiert wird, können Sie sie im Code nach Belieben erweitern oder ändern. Stellen Sie nur sicher, dass Sie Ihre Änderungen von den Kern-Dateien getrennt halten, um zu vermeiden, dass sie beim Update auf eine neue Version überschrieben werden.

Die meisten Erweiterungen synchronisieren Daten, indem sie Endpunkte im Webshop erstellen, die dann mit den öffentlichen und privaten Schlüsseln abgerufen werden.

Wenn Sie eine Datensynchronisierung durchführen, greift der Importeur von Clerk auf jeden Endpunkt zu, um die Daten im JSON-Format über die Paginierung 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, um Daten zu synchronisieren, während 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, sodass Sie deren Code nicht ändern können, sie enthalten jedoch verschiedene Konfigurationsoptionen von der Daten-Seite.

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 sie weiterhin nur zur Synchronisierung von Daten verwenden und dann die API oder Snippets für das Frontend nutzen. Denken Sie an sie als Werkzeugkästen, um Teile der Einrichtung zu erleichtern.

Ihre Einrichtung wählen #

Eine Clerk.js-Integration ist oft die schnellste und lässt den nicht-technischen Mitarbeitern Ihres Unternehmens mehr Kontrolle über die Einrichtung nach der Integration.

Sie müssen sich auch keine Sorgen um Tracking und zusätzliche Serverlast machen, da Clerk.js im Frontend arbeitet, während die Seite geladen wird.

API-Setups sind am besten, wenn Sie signifikante benutzerdefinierte Geschäftslogik anwenden müssen.

Wenn Sie beispielsweise einen B2B-Shop mit einzigartigen Preisen und Katalogen für jeden angemeldeten Kunden entwickeln, ist es einfacher, API-Aufrufe serverseitig zu tätigen und die Geschäftslogik nachdem Clerk die Ergebnisse zurückgibt, anzuwenden.

Ein weiterer Fall ist, wenn Sie von einer anderen API zu Clerk wechseln müssen. Es ist oft schneller, einfach API-Aufrufe zu ersetzen und Parameter neu zuzuordnen, als eine Clerk.js-Installation durchzuführen.

Schließlich, wenn Sie eine App erstellen, ist die Verwendung der API normalerweise der beste Weg, um sie mit Clerk.io zu verbinden, und es ist im Allgemeinen der einzige Weg, wenn die App JavaScript nicht unterstützt.