Overview

Al kommunikation med Clerk.io’s AI foregår gennem vores lynhurtige REST API.

Uanset webshop-platformen kan Clerk altid integreres via API eller med vores Clerk.js løsning, som laver API-kald fra frontend.

Vi bygger derefter extensions og integrations, der samler funktioner fra API’et og Clerk.js for at gøre integrationen smidig for enhver platform.

API #

Dette er grundstenen i Clerk.io’s funktionalitet. Det er tilgængeligt på denne URL:

https://api.clerk.io/v2

Du kommunikerer med API’et ved hjælp af API-nøgler og en række forskellige endpoints, der returnerer data i JSON-format.

Call

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

Response

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

Opsætning af denne kommunikation kræver, at du synkroniserer data, henter resultater, visualiserer disse resultater og tilføjer tracking. Alle detaljer findes i API guide.

Clerk.js #

Dette JavaScript-bibliotek gør det nemt at integrere Clerk.io’s services i enhver frontend.

Clerk.js klarer alt det tunge arbejde, såsom at lave netværksforespørgsler, håndtere fejl elegant, rendre i DOM’en og anvende tracking ud af boksen.

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

Opsætning af Clerk.js kræver, at du indsætter tracking-scripts, laver designs og tilføjer snippets til din frontend. Alle detaljer findes i Getting Started guide.

Extensions #

Disse installeres på platformen som pakker, der samler data feeds, API-kald og Clerk.js. De håndterer synkronisering, tracking og indsættelse af snippets. Eksempler inkluderer:

• Magento2
• WooCommerce
• Prestashop

Da extension’en installeres på din server, kan du udvide eller ændre den i koden, som du ønsker. Sørg blot for at holde dine ændringer adskilt fra kernefilerne, så de ikke bliver overskrevet ved opdatering til en ny version.

De fleste extensions synkroniserer data ved at oprette endpoints på webshoppen, som derefter tilgås med Public og Private Keys.

Når du kører en data-synkronisering, tilgår Clerk’s importer hvert endpoint for at modtage dataene i JSON-format via pagination:

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

Integrations #

Disse bruger webshop-platformens API til at synkronisere data, mens snippets skal indsættes manuelt i webshop-filerne. Eksempler inkluderer:

• Shopify
• BigCommerce
• Lightspeed

Integrations hostes på Clerk.io’s servere, så du kan ikke ændre deres kode, men de indeholder forskellige konfigurationsmuligheder fra Data-siden.

Hvis vi har en extension eller integration til din platform, anbefaler vi at bruge denne for at forenkle mindst dele af installationen.

Du kan stadig vælge kun at bruge dem til at synkronisere data og derefter bruge API eller snippets til frontend. Tænk på dem som værktøjskasser, der gør dele af opsætningen nemmere.

Valg af opsætning #

En Clerk.js-integration er ofte den hurtigste og giver ikke-tekniske medarbejdere i din virksomhed mere kontrol over opsætningen efter integrationen.

Du behøver heller ikke bekymre dig om tracking og ekstra serverbelastning, da Clerk.js kører i frontend, mens siden loader.

API-opsætninger er bedst, hvis du har væsentlig tilpasset forretningslogik, du skal anvende.

Hvis du for eksempel udvikler en B2B-shop med unikke priser og kataloger for hver indlogget kunde, er det nemmere at lave API-kald serverside og anvende forretningslogikken efter, at Clerk returnerer resultaterne.

Et andet tilfælde er, hvis du skal skifte fra et andet API til Clerk. Det er ofte hurtigere blot at udskifte API-kald og ommappe parametre end at lave en Clerk.js-installation.

Endelig, hvis du bygger en app, er det normalt bedst at bruge API’et til at forbinde den med Clerk.io, og det er generelt den eneste vej, hvis appen ikke understøtter JavaScript.