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 über die API oder mit unserer Clerk.js-Lösung integriert werden, die API-Aufrufe direkt vom Frontend ausführt.

Wir entwickeln dann Erweiterungen und Integrationen, die Funktionen der API und Clerk.js bündeln, um die Integration für jede 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

Sie kommunizieren mit der API unter Verwendung von API-Schlüsseln und einer Vielzahl verschiedener Endpunkte, 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
}

Um diese Kommunikation einzurichten, müssen Sie Daten synchronisieren, Ergebnisse abrufen, diese visualisieren und Tracking hinzufügen. Alle Details sind im API-Leitfaden beschrieben.

Clerk.js #

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

Clerk.js übernimmt die komplette Arbeit, wie das Ausführen von Netzwerkanfragen, das elegante Behandeln von Fehlern, das Rendering im DOM und das Anwenden von Tracking - alles von Haus aus.

<!--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>

Die Einrichtung von Clerk.js erfordert das Einfügen der Tracking-Skripte, das Erstellen von Designs und das Hinzufügen von Snippets im Frontend. Alle Details finden Sie im Getting Started Guide.

Erweiterungen #

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

• Magento2
• WooCommerce
• Prestashop

Da die Erweiterung auf Ihrem Server installiert wird, können Sie sie im Code beliebig erweitern oder anpassen. Achten Sie nur darauf, Ihre Änderungen getrennt von den Core-Dateien zu halten, um ein Überschreiben beim Update auf eine neue Version zu vermeiden.

Die meisten Erweiterungen synchronisieren Daten, indem sie Endpunkte im Webshop erstellen, die dann mit Public und Private Keys aufgerufen werden.

Wenn Sie eine Datensynchronisierung durchführen, greift der Importer von Clerk auf jeden Endpunkt zu, um die Daten im JSON-Format per Paginierung abzurufen:

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, 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. Sie können deren Code zwar nicht anpassen, aber sie verfügen über verschiedene Konfigurationsoptionen auf der Data-Seite.

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

Sie können sie dennoch ausschließlich zur Datensynchronisierung verwenden und dann die API oder Snippets für das Frontend nutzen. Sehen Sie sie als Toolkits, um bestimmte Setupprozesse zu erleichtern.

Die Wahl Ihres Setups #

Eine Clerk.js-Integration ist oft die schnellste Lösung und überlässt nach der Integration den nicht-technischen Mitarbeitern Ihres Unternehmens mehr Kontrolle über das Setup.

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

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

Wenn Sie beispielsweise einen B2B-Store mit individuellen Preisen und Katalogen für jeden eingeloggten Kunden entwickeln, ist es einfacher, API-Aufrufe serverseitig durchzuführen und die Business-Logik nachdem Clerk Ergebnisse geliefert hat, anzuwenden.

Ein weiterer Anwendungsfall ist der Wechsel von einer anderen API zu Clerk. Meist ist es schneller, einfach die API-Aufrufe auszutauschen und Parameter neu zuzuordnen, als eine Clerk.js-Integration vorzunehmen.

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