Overview

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

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

Vi udvikler derefter extensions og integrations, der samler funktioner fra API og Clerk.js for at gøre integrationen nem for enhver platform.

API #

Dette er hjørnestenen i Clerk.io’s funktionalitet. Den er tilgængelig 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 er beskrevet 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, rendere i DOM’en og anvende tracking automatisk.

<!--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 er beskrevet i Getting Started guide.

Extensions #

Disse installeres i 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 extensionen installeres på din server, kan du udvide eller ændre den i koden, som du ønsker. Sørg blot for at holde ændringerne adskilt fra kernefilerne, så de ikke overskrives ved opdatering til en ny version.

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

Når du kører en datasynkronisering, tilgår Clerk’s importer hvert endpoint for at modtage data 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 webshoppens filer. Eksempler inkluderer:

• Shopify
• BigCommerce
• Lightspeed

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

Hvis vi har en extension eller integration til din platform, anbefaler vi at bruge den for at gøre installationen nemmere.

Du kan stadig vælge kun at bruge dem til synkronisering af data og dernæst bruge API eller snippets til frontend. Tænk på dem som værktøjskasser til at gøre dele af opsætningen lettere.

Vælg din opsætning #

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

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

API-opsætninger er bedst, hvis du har betydelig egen forretningslogik, der skal anvendes.

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

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 remappe parametre end at udføre en Clerk.js installation.

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