Overview

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

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.

Después, creamos extensiones e integraciones que agrupan funcionalidades de la API y Clerk.js para que la integración sea sencilla 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 utilizando claves API y una variedad de endpoints diferentes 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 añadas seguimiento. Todos los detalles están explicados 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 forma elegante, 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 insertar los scripts de seguimiento, crear los diseños y añadir fragmentos al frontend. Todos los detalles están explicados 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. Los ejemplos incluyen:

• Magento2
• WooCommerce
• Prestashop

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

La mayoría de las extensiones sincronizan datos creando endpoints en la tienda online, a los que se accede con las claves pública y privada.

Al ejecutar 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 insertarse manualmente en los archivos de la tienda. Los ejemplos incluyen:

• Shopify
• BigCommerce
• Lightspeed

Las integraciones se alojan en los servidores de Clerk.io, así que aunque no puedas 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, recomendamos usarla para simplificar, al menos, partes de la instalación.

Aun así, puedes decidir usarlas solo para sincronizar datos y después utilizar 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 Clerk.js suele ser lo más rápido y deja a los empleados no técnicos de tu empresa con más control sobre la configuración después de la integración.

Tampoco tienes que preocuparte por el seguimiento ni por añadir carga al servidor, ya que Clerk.js funciona en el frontend mientras la página se carga.

Las configuraciones por API son 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 autenticado, es más fácil hacer las llamadas API en el servidor y aplicar la lógica de negocio después de que Clerk devuelva los resultados.

Otro caso es si necesitas realizar una migración de otra API a Clerk. Suele ser más rápido simplemente reemplazar llamadas API y reasignar parámetros que hacer una instalación de Clerk.js.

Por último, si estás desarrollando una app, usar la API suele ser la mejor forma de conectarla con Clerk.io, y normalmente es la única forma si la app no soporta JavaScript.