Overview

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

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

Successivamente, costruiamo estensioni e integrazioni che raccolgono 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

La comunicazione con l’API avviene tramite 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
}

Configurare questa comunicazione richiede di sincronizzare i dati, recuperare i risultati, visualizzare tali risultati e aggiungere il tracking. Tutti i dettagli sono illustrati nella guida API.

Clerk.js #

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

Clerk.js si occupa di tutte le operazioni complesse, come effettuare richieste di rete, gestire gli errori in modo efficiente, effettuare il rendering nel DOM e applicare il tracking già pronto all’uso.

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

Configurare Clerk.js richiede l’inserimento degli script di tracking, la creazione dei design e l’aggiunta di snippet nel frontend. Tutti i dettagli sono illustrati nella guida introduttiva.

Estensioni #

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

• Magento2
• WooCommerce
• Prestashop

Poiché l’estensione sarà installata sul tuo server, puoi estenderla o modificarla nel codice come preferisci. Assicurati solo di mantenere le tue modifiche separate dai file principali per evitare di sovrascriverle durante l’aggiornamento a una nuova release.

La maggior parte delle estensioni sincronizza i dati creando endpoint sullo shop online, che vengono poi accessibili tramite le chiavi Public e Private.

Quando avvii una sincronizzazione dati, l’importatore di Clerk accede a ciascun endpoint per ricevere i dati in formato JSON, tramite 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 e-commerce per sincronizzare i dati, mentre gli snippet devono essere inseriti manualmente nei file del negozio. Esempi includono:

• Shopify
• BigCommerce
• Lightspeed

Le integrazioni sono ospitate sui server di Clerk.io, quindi, anche se non puoi modificarne il codice, dispongono di diverse opzioni di configurazione dalla pagina Dati.

Se disponiamo di un’estensione o di un’integrazione per la tua piattaforma, ti consigliamo di utilizzarla per semplificare almeno parte dell’installazione.

Puoi comunque scegliere di utilizzarle solo per la sincronizzazione dei dati e poi usare l’API o gli snippet per il frontend. Considerale come toolkit per semplificare alcune parti della configurazione.

Scegliere la Configurazione #

Realizzare un’integrazione Clerk.js è spesso la soluzione più rapida e lascia ai dipendenti non tecnici della tua azienda un maggiore controllo sulla configurazione dopo l’integrazione.

Inoltre non devi preoccuparti del tracking né del carico sul server, poiché Clerk.js funziona nel frontend durante il caricamento della pagina.

Le configurazioni API sono consigliate se hai una logica aziendale personalizzata significativa da applicare.

Ad esempio, se stai sviluppando uno store B2B con prezzi e cataloghi unici per ogni cliente autenticato, è più semplice effettuare chiamate API lato server e applicare la logica aziendale dopo che Clerk restituisce i risultati.

Un altro caso riguarda lo switch da un’altra API a Clerk. Spesso è più veloce sostituire semplicemente le chiamate API e rimappare i parametri, piuttosto che implementare Clerk.js.

Infine, se stai costruendo un’app, l’utilizzo dell’API è normalmente il modo migliore per collegarla con Clerk.io, e generalmente è anche l’unico metodo possibile quando l’app non supporta JavaScript.