Configuración de la Tienda

En esta sección, aprenderá cómo configurar su tienda para registrar acciones de compra y calificaciones de productos.

Usando la Clave de API

Para registrar acciones desde su tienda, necesita la clave de API de la tienda. La encontrará en la página Mis tiendas haciendo clic en el botón Clave de API para la tienda correspondiente.

Una vez que tenga su clave de API, puede comenzar a enviar acciones a nuestro servidor.

Clave de API de ejemplo:

cleard.sapun.bg.n81sjpKAg1Or

Para crear un registro exitosamente, incluya su clave de API en un encabezado dedicado en la solicitud POST: cleard-api-key.

Envíe la solicitud POST a https://cleard.com/api/action.

Parámetros de la Solicitud

Sus solicitudes deben incluir los siguientes parámetros:

Para agregar al carrito:

{
    "link": "https://sapun.bg/vanilla-soap", // Enlace a la página de su producto
    "title": "Vanilla soap", // Título de su producto
    "image": "https://sapun.bg/images/vanilla-soap.png", // Imagen del producto
    "type": "add-to-cart", // Tipo de registro. Puede ser "add-to-cart" o "rate"
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Identificador del usuario que realizó la acción ➀
    }
}

Para agregar una calificación a un producto:

{
    "link": "https://sapun.bg/vanilla-soap", // Enlace a la página de su producto
    "title": "Vanilla soap", // Título de su producto
    "image": "https://sapun.bg/images/vanilla-soap.png", // Imagen del producto
    "type": "rate", // Tipo de registro. Puede ser "add-to-cart" o "rate"
    "rating": {
        "rate": 4, // Calificación del producto. El valor debe ser de 1 a 5 inclusive.
        "description": "Great soap!" // Comentario de calificación. Opcional.
    },
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Identificador del usuario que realizó la acción ➀
    }
}

➀ Identificador del Usuario

El identificador del usuario se puede obtener de la cookie cleard-user.

Si el usuario no ha iniciado sesión en su cuenta Clear'd, no habrá identificador. En este caso, puede enviar el nombre y la foto del usuario de su propia base de datos de la siguiente manera:

{
    ...
    "user": {
        "name": "John Doe", // Nombre del usuario
        "photoURL": "https://sapun.bg/images/avatars/user-22.png" // Foto del usuario
    }
}