Overview

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

Indipendentemente dalla piattaforma dell’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 raggruppano le funzionalità dell’API e Clerk.js per rendere l’integrazione fluida su qualsiasi piattaforma.

API #

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

https://api.clerk.io/v2

La comunicazione con l’API avviene utilizzando le chiavi API e una serie di differenti 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
}

La configurazione di questa comunicazione richiede la sincronizzazione dei dati, il recupero dei risultati, la visualizzazione di questi risultati e l’aggiunta del tracking. Tutti i dettagli sono illustrati 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 efficiente, eseguire il rendering nel DOM e applicare il tracking automaticamente.

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

Per configurare Clerk.js è necessario inserire gli script di tracking, creare i design e aggiungere i frammenti di codice al frontend. Tutti i dettagli sono illustrati nella Guida introduttiva.

Estensioni #

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

• Magento2
• WooCommerce
• Prestashop

Poiché l’estensione verrà installata sul tuo server, potrai estenderla o modificarla nel codice come preferisci. Assicurati soltanto di mantenere le tue modifiche separate dai file principali per evitare di sovrascriverle quando aggiorni a una nuova release.

La maggior parte delle estensioni sincronizza i dati creando endpoint sull’e-commerce, che vengono poi acceduti tramite le Public e Private Keys.

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

• Shopify
• BigCommerce
• Lightspeed

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

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

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

Scegliere la tua configurazione #

L’integrazione tramite Clerk.js è spesso la più veloce e lascia ai dipendenti non tecnici della tua azienda maggiore controllo sulla configurazione successiva.

Non devi nemmeno preoccuparti del tracking e del carico sul server, poiché Clerk.js lavora nel frontend mentre la pagina sta caricando.

Le configurazioni tramite API sono la scelta migliore se hai una logica aziendale molto personalizzata da applicare.

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

Un altro caso è se hai bisogno di fare una migrazione da un’altra API a Clerk. Spesso è più rapido semplicemente sostituire le chiamate API e rimappare i parametri, rispetto a implementare un’installazione Clerk.js.

Infine, se stai sviluppando un’app, utilizzare l’API è normalmente il modo migliore per collegarla con Clerk.io, ed è generalmente l’unica soluzione quando l’app non supporta JavaScript.