Overview

Toda la comunicación con la IA de Clerk.io ocurre a través de nuestra API REST ultrarrápida.

Independientemente de la plataforma de la tienda online, Clerk siempre puede integrarse vía API o con nuestra solución Clerk.js que realiza llamadas API desde el frontend.

Luego desarrollamos extensiones e integraciones que agrupan características de la API y Clerk.js para hacer la integración fluida en cualquier plataforma.

API #

Esta es la piedra angular de la funcionalidad de Clerk.io. Es accesible en esta URL:

https://api.clerk.io/v2

Te comunicas con la API usando claves de API y una serie de endpoints diferentes que devuelven datos en formato JSON.

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
}

Configurar esta comunicación requiere que sincronices datos, recuperes resultados, visualices estos resultados y añadas seguimiento. Todos los detalles están descritos en la guía de API.

Clerk.js #

Esta biblioteca de JavaScript facilita la integración de los servicios de Clerk.io en cualquier frontend.

Clerk.js se encarga de todo el trabajo pesado, como realizar solicitudes de red, manejar errores de manera eficiente, renderizar en el DOM y aplicar seguimiento de forma automática.

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

Configurar Clerk.js requiere que insertes los scripts de seguimiento, crees diseños y añadas fragmentos a tu frontend. Todos los detalles están descritos en la guía de introducción.

Extensiones #

Estas se instalan en la plataforma como paquetes que agrupan fuentes de datos, llamadas a la API y Clerk.js. Se encargan de la sincronización, el seguimiento y la inserción de fragmentos. Ejemplos incluyen:

• Magento2
• WooCommerce
• Prestashop

Dado que la extensión se instalará en tu servidor, puedes ampliarla o modificarla en el código como desees. Solo asegúrate de mantener tus cambios separados de los archivos principales para evitar sobrescribirlos cuando actualices a una nueva versión.

La mayoría de las extensiones sincronizan información creando endpoints en la tienda online, que luego son accedidos con las Public y Private Keys.

Cuando ejecutas una sincronización de datos, el importador de Clerk accede a cada endpoint para recibir los datos en formato JSON, mediante paginación:

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

Integraciones #

Estas utilizan la API de la plataforma de la tienda online para sincronizar datos, mientras que los fragmentos deben ser insertados manualmente en los archivos de la tienda. Ejemplos incluyen:

• Shopify
• BigCommerce
• Lightspeed

Las integraciones se alojan en los servidores de Clerk.io, por lo que, aunque no puedes modificar su código, cuentan con varias opciones de configuración desde la página de Datos.

Si tenemos una extensión o integración para tu plataforma, te recomendamos utilizarla para simplificar al menos parte de la instalación.

Aun así, puedes optar por usarlas solo para la sincronización de datos y luego utilizar la API o los fragmentos en el frontend. Considéralas como kits de herramientas para facilitar partes del proceso de configuración.

Cómo elegir tu configuración #

Realizar una integración con Clerk.js suele ser lo más rápido y deja a los empleados no técnicos de tu empresa con mayor control de la configuración después de la integración.

Tampoco tendrás que preocuparte por el seguimiento ni por cargar el servidor, ya que Clerk.js funciona en el frontend mientras se carga la página.

Las configuraciones de API son las mejores si necesitas aplicar una lógica de negocio personalizada significativa.

Por ejemplo, si estás desarrollando una tienda B2B con precios y catálogos únicos para cada cliente que inicia sesión, es más fácil realizar llamadas API desde el servidor y aplicar la lógica de negocio después de que Clerk devuelva los resultados.

Otro caso es si necesitas cambiar de otra API a Clerk. A menudo es más rápido simplemente reemplazar las llamadas API y reasignar parámetros, que realizar una instalación de Clerk.js.

Por último, si estás creando una aplicación, usar la API normalmente es la mejor manera de conectarla con Clerk.io, y generalmente es la única forma cuando la aplicación no admite JavaScript.