Overview

Tutta la comunicazione con l’AI di Clerk.io avviene tramite la nostra super veloce REST API.

Indipendentemente dalla piattaforma del webshop, Clerk può sempre essere integrato tramite API o con la nostra soluzione Clerk.js che effettua chiamate API dal frontend.

Costruiamo quindi estensioni e integrazioni che raggruppano funzionalità dall’API e Clerk.js per rendere l’integrazione fluida per qualsiasi piattaforma.

API #

Questa è la pietra miliare della funzionalità di Clerk.io. È accessibile a questo URL:

https://api.clerk.io/v2

Comunichi con l’API utilizzando chiavi API e una serie di diversi endpoint che restituiscono dati in formato JSON.

Chiamata

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

Risposta

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

Impostare questa comunicazione richiede di sincronizzare i dati, recuperare i risultati, visualizzare questi risultati e aggiungere tracciamento. Tutti i dettagli sono descritti nella guida API.

Clerk.js #

Questa libreria JavaScript rende facile integrare i servizi di Clerk.io in qualsiasi frontend.

Clerk.js si occupa di tutto il lavoro pesante, come effettuare richieste di rete, gestire gli errori in modo elegante, renderizzare nel DOM e applicare il tracciamento out of the box.

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

Impostare Clerk.js richiede di inserire gli script di tracciamento, creare design e aggiungere snippet al tuo frontend. Tutti i dettagli sono descritti nella guida Getting Started.

Estensioni #

Queste vengono installate nella piattaforma come pacchetti che raggruppano feed di dati, chiamate API e Clerk.js. Gestiscono la sincronizzazione, il tracciamento e l’inserimento di snippet. Esempi includono:

• Magento2
• WooCommerce
• Prestashop

Poiché l’estensione sarà installata sul tuo server, puoi estenderla o modificarla nel codice come ritieni opportuno. Assicurati solo di mantenere le tue modifiche separate dai file core per evitare di sovrascriverli quando aggiorni a una nuova versione.

La maggior parte delle estensioni sincronizza i dati creando endpoint sul webshop, che vengono poi accessibili con le chiavi pubbliche e private.

Quando esegui una sincronizzazione dei dati, l’importatore di Clerk accede a ciascun endpoint per ricevere i dati in formato JSON, attraverso la paginazione:

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

Integrazioni #

Queste utilizzano l’API della piattaforma del webshop per sincronizzare i dati, mentre gli snippet devono essere inseriti manualmente nei file del webshop. Esempi includono:

• Shopify
• BigCommerce
• Lightspeed

Le integrazioni sono ospitate sui server di Clerk.io, quindi mentre non puoi modificare il loro codice, contengono varie opzioni di configurazione dalla pagina Dati.

Se abbiamo un’estensione o un’integrazione per la tua piattaforma, ti consigliamo di usarla per semplificare almeno alcune parti dell’installazione.

Puoi comunque scegliere di utilizzarle solo per sincronizzare i dati e poi usare l’API o gli snippet per il frontend. Pensale come kit di strumenti per rendere più facile alcune parti della configurazione.

Scegliere la tua configurazione #

Fare un’integrazione Clerk.js è spesso il modo più veloce e lascia i dipendenti non tecnici della tua azienda con maggiore controllo sulla configurazione dopo l’integrazione.

Non devi nemmeno preoccuparti del tracciamento e dell’aggiunta di carico al server, poiché Clerk.js funziona nel frontend mentre la pagina si carica.

Le configurazioni API sono migliori se hai una logica aziendale personalizzata significativa che devi applicare.

Ad esempio, se stai sviluppando un negozio B2B con prezzi e cataloghi unici per ciascun cliente registrato, è più facile effettuare chiamate API lato server e applicare la logica aziendale dopo che Clerk restituisce i risultati.

Un altro caso è se hai bisogno di passare da un’altra API a Clerk. È spesso più veloce semplicemente sostituire le chiamate API e rimappare i parametri, piuttosto che fare un’installazione di Clerk.js.

Infine, se stai costruendo un’app, utilizzare l’API è normalmente il modo migliore per collegarla a Clerk.io, ed è generalmente l’unico modo quando l’app non supporta JavaScript.