Hiboutik API REST : Webhooks

callback-url

Un Webhook es una dirección web invocada cuando ocurre un evento.
Ejemplo: cuando cerramos una venta (= evento), Hiboutik puede enviar los datos de esta venta a una URL específica.
Podemos configurar los Webhooks en la pestaña «Configuración / Configuración general» de nuestra cuenta.

 

1 / ¿Cuando necesitaría un Webhook?

Un Webhook permite un comportamiento dinámico, como invocar uno o varios scripts cuando ocurre un evento.

Exponemos varios ejemplos :
Cuando cerramos una venta, podemos sincronizarla con el stock de nuestro espacio web o enviar automáticamente una encuesta al cliente.
Cuando creamos un producto, podemos iniciar un script para agregar también el producto al back-office de nuestra web.
Cuando actualizamos un formulario de cliente, podemos enviarle automáticamente un correo electrónico confirmando la modificación.

En general, podemos iniciar una o varias acciones cuando ocurre un evento, como enviar un SMS o incluso cambiar la intensidad de la luz en nuestra tienda.

 

2 / ¿Cómo funciona un Webhook en Hiboutik?

Los Webhook son específicas de cada punto de venta en una cuenta multi-tienda.

Los eventos que pueden activar un Webhook son:

Nombre del webhook Eventos – Descripción
Ventas Cerrar una venta.
Añadir un producto Añadir un producto en una venta.
Ventas Hacer clic en el ícono en la venta.
Pago Agregar / eliminar un método de pago en una venta.
Clientes Crear / modificar un formulario de cliente.
Crédito Agregar una linea de crédito en la ficha del cliente.
Productos Agregar / modificar / eliminar un producto.
Entradas Recepcionar una entrada.
Marca de tiempo Agregar / parar una marca de tiempo.
Planificación Agregar / modificar / eliminar un evento de la planificación.
Transferencia Validar una transferencia.
Devolución/cambio Cambiar un producto en una venta.

Los datos se envían en POST a los Webhooks y son diferentes de un evento a otro.
Por ejemplo, los datos enviados cuando cerramos una venta son los siguientes (GET /sales/{sale_id}) :
– Información del cliente y sus direcciones,
– Lista de los productos vendidos (precios, código de barras, descripción…),
– Impuestos y totales,
– modos de pago y sus vencimientos,
– y todas las informaciones específicas de la venta (comentarios, vendedor, fechas…).

Podemos utilizar la API de Hiboutik para obtener más información.

 

3 / Caso de estudio: Webhook y el programa de fidelización

En cada ficha de producto, podemos registrar los puntos de fidelidad obtenidos cuando el cliente compra el producto. Los puntos de fidelidad son invariables.
Pero si estamos vendiendo un producto con precio libre (cuando el precio se indica en el momento de la venta y podemos cambiarlo de una venta a otra), no sería posible vincularlo proporcionalmente a puntos de fidelidad.
Para resolver este problema utilizaremos la API de Hiboutik para recalcular los puntos de fidelidad cuando se cierre una venta.

a / Descargamos e instalamos el script
Recuperamos nuestra clave de API en «Configuración / Usuarios / API» en la cuenta de Hiboutik.
Descargamos el siguiente script y lo modificamos con el nombre de nuestra cuenta, dirección de correo electrónico y nuestra clave API (líneas 20, 21 y 22):
https://github.com/hiboutik/hiboutikapi/blob/master/examples/fidelite.php
Instalamos el script en nuestra solución de alojamiento y la hacemos ejecutable.

b / Configuramos nuestro Webhook
En la pestaña «Configuración/Configuración general», ingresamos la dirección URL de nuestro script en el campo «Ventas: Webhook».
Ejemplo: http://mydomain.com/fidelite.php

Ahora, cuando cerremos una venta, nos recalculará automáticamente los puntos de fidelidad de acuerdo con la regla que ingresemos en nuestro script.

El búho ha escrito 55 artículos