Overview

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

Independientemente de la plataforma de la tienda en línea, Clerk siempre se puede integrar a través de API o con nuestra solución Clerk.js que realiza llamadas a la API desde el frontend.

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

API #

Este 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 utilizando claves API y una variedad de diferentes endpoints que devuelven datos en formato JSON.

Llamada

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

Respuesta

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

Configurar esta comunicación requiere que sincronices datos, recuperes resultados, visualices estos resultados y agregues seguimiento. Todos los detalles están delineados 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 realiza todo el trabajo pesado, como hacer solicitudes de red, manejar errores de manera elegante, renderizar en el DOM y aplicar seguimiento de forma predeterminada.

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

<!--Snippet de recomendaciones-->
<span class="clerk" data-template="@bestsellers"></span>

Configurar Clerk.js requiere que insertes los scripts de seguimiento, crees diseños y agregues fragmentos a tu frontend. Todos los detalles están delineados en la guía de Inicio Rápido.

Extensiones #

Estas se instalan en la plataforma como paquetes que agrupan feeds de datos, llamadas a la API y Clerk.js. Manejan 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 extenderla o cambiarla en el código como lo consideres necesario. 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 datos creando endpoints en la tienda en línea, que luego se acceden con las Claves Públicas y Privadas.

Cuando ejecutas una sincronización de datos, el importador de Clerk accede a cada endpoint para recibir los datos en formato JSON, a través de 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 en línea para sincronizar datos, mientras que los fragmentos deben ser insertados manualmente en los archivos de la tienda en línea. 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, contienen varias opciones de configuración desde la página de Datos.

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

Aún puedes optar por usarlas solo para sincronizar datos y luego usar la API o fragmentos para el frontend. Piensa en ellas como kits de herramientas para facilitar partes de la configuración.

Elegir tu Configuración #

Hacer una integración de Clerk.js es a menudo la más rápida y deja a los empleados no técnicos de tu empresa con más control de la configuración después de la integración.

Tampoco tienes que preocuparte por el seguimiento y la carga del servidor, ya que Clerk.js funciona en el frontend mientras se carga la página.

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

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 hacer llamadas a la API del lado del servidor y aplicar la lógica de negocio después de que Clerk devuelva resultados.

Otro caso es si necesitas hacer un cambio de otra API a Clerk. A menudo es más rápido simplemente reemplazar llamadas a la API y remapear parámetros, que hacer una instalación de Clerk.js.

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