Overview

Al kommunikation med Clerk.io’s AI sker gennem vores superhurtige REST API.

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

Vi bygger derefter udvidelser og integrationer, der samler funktioner fra API’et og Clerk.js for at gøre integrationen glat for enhver platform.

API #

Dette er hjørnestenen 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 slutpunkter, 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 sporing. Alle detaljer er beskrevet i API-guiden.

Clerk.js #

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

Clerk.js udfører alt det tunge arbejde, såsom at foretage netværksanmodninger, håndtere fejl elegant, gengive i DOM’en og anvende sporing 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 sporingsscripts, opretter designs og tilføjer snippets til din frontend. Alle detaljer er beskrevet i Kom godt i gang-guiden.

Extensions #

Disse installeres i platformen som pakker, der samler datafeeds, API-opkald og Clerk.js. De håndterer synkronisering, sporing og indsættelse af snippets. Eksempler inkluderer:

• Magento2
• WooCommerce
• Prestashop

Da udvidelsen vil blive installeret på din server, kan du udvide eller ændre den i koden, som du ønsker. Sørg blot for at holde dine ændringer adskilt fra kernefilene for at undgå at overskrive dem, når du opdaterer til en ny version.

De fleste udvidelser synkroniserer data ved at oprette slutpunkter på webshoppen, som derefter tilgås med de offentlige og private nøgler.

Når du kører en datasynkronisering, tilgår Clerk’s importer hvert slutpunkt for at modtage dataene i JSON-format gennem paginering:

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 webshopplatformens API til at synkronisere data, mens snippets skal indsættes manuelt i webshopfilene. Eksempler inkluderer:

• Shopify
• BigCommerce
• Lightspeed

Integrationer er hostet på Clerk.io’s servere, så mens du ikke kan ændre deres kode, indeholder de forskellige konfigurationsmuligheder fra Databladet.

Hvis vi har en udvidelse eller integration til din platform, anbefaler vi at bruge den for at forenkle i det mindste dele af installationen.

Du kan stadig vælge at bruge dem kun til at synkronisere data og derefter bruge API’et eller snippets til frontend. Tænk på dem som værktøjssæt til at gøre dele af opsætningen lettere.

Choosing Your Setup #

At lave 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 skal heller ikke bekymre dig om sporing og tilføjelse af serverbelastning, da Clerk.js arbejder i frontend, mens siden indlæses.

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

For eksempel, hvis du udvikler en B2B-butik med unikke priser og kataloger for hver indlogget kunde, er det lettere at foretage API-opkald på serversiden og anvende forretningslogikken efter Clerk returnerer resultater.

Et andet tilfælde er, hvis du har brug for at skifte fra et andet API til Clerk. Det er ofte hurtigere blot at erstatte API-opkald og remappe parametre end at lave en Clerk.js-installation.

Endelig, hvis du bygger en app, er det normalt den bedste måde at forbinde den med Clerk.io at bruge API’et, og det er generelt den eneste måde, når appen ikke understøtter JavaScript.