Hiboutik API REST : Callback URL

callback-url

Una callback URL (retrollamada) 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 las callback URLs en la pestaña “Configuración / Configuración general” de nuestra cuenta.

 

1 / ¿Cuando necesitaría una/s callback URL?

Una callback URL 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 una callback URL en Hiboutik?

Las callback URLs son específicas de cada punto de venta en una cuenta multi-tienda.

Los eventos que pueden activar una callback URL son:
– Cerrar una venta,
– Seleccionar / agregar / eliminar un método de pago en una venta,
– Hacer clic en el ícono de Callback en la venta,
– Crear / modificar un formulario de cliente,
– Detener un contador de tiempo,
– Agregar / modificar / eliminar un evento de la planificación.

Los datos se envían en POST a las callback URL y son diferentes de un evento a otro.
Por ejemplo, los datos enviados cuando cerramos una venta son los siguientes:
– order_id: la ID de venta
– unique_order_id: la ID de una venta cerrada (número de venta continuo y cronológico)
– shop_id: el ID de la tienda (para cuentas multi-tiendas)
– customer_id: la ID del cliente
– vendor_id: la ID del vendedor
– date_time: la fecha y hora del cierre de la venta

Podemos utilizar la API de Hiboutik para obtener más información, como reponer productos vendidos en la venta.

 

3 / Caso de estudio: Callback URL 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 / Usuarios” en la cuenta de Hiboutik (hacemos clic en el ícono de la llave inglesa que está frente a nuestro nombre).
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 nuestra callback URL
En la pestaña “Configuración/Configuración general”, ingresamos la dirección URL de nuestro script en el campo “Ventas: callback URL”.
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 50 artículos