API REST Hiboutik : URL de callback

callback-url

 

L’URL de callback est une adresse web appelée lorsqu’une action est réalisée.
Ex: A la validation d’une vente (=action), Hiboutik envoi les informations relatives à la vente validée à « l’URL de callback Ventes » que vous avez spécifiée.
Les URLs de callback sont à saisir dans la section « Paramètres/Paramètres généraux » de votre compte Hiboutik.

 

1/ Pourquoi les URLs de callback ?

L’URL de callback permet de lancer l’exécution d’un ou plusieurs scripts a la suite d’une action.

Voici quelques exemples pour mieux comprendre:
A la validation d’une vente, vous pouvez déclencher la synchronisation du stock de votre site web ou l’envoi automatique d’un sondage par email au client.
A la création d’un produit, vous pouvez déclencher un script de création d’un produit également sur votre plateforme web.
A la modification d’un client, vous pouvez lui envoyer automatiquement un email de confirmation.

D’une manière générale, vous pouvez déclencher une ou de multiples opérations lorsqu’une action est réalisée. Cela peut aller du simple envoi de SMS à la variation de l’intensité lumineuse dans votre magasin.

 

2/ Les URLs de callback dans Hiboutik

Les URLs de callback sont propres à chaque point de vente.

Les actions qui peuvent être liées à un URL de callback sont les suivantes:
– Validation d’une vente,
– Ajout/Suppression d’un moyen de paiement sur une vente,
– Click de callback sur une vente (icône),
– Création/modification d’un client,
– Création/modification d’un produit,
– Arrêt d’une ligne temps dans l’horodatage.
– Ajout/modification/suppression d’un événement dans le planning.

Les informations transmises en POST à l’URL de callback varient en fonction de l’action.
Par exemple, les informations transmises à la validation d’une vente sont les suivantes:
– order_id : le numéro de la vente
– unique_order_id : l’identifiant unique de la vente
– shop_id : l’identifiant du point de vente (cas des multi-boutiques)
– customer_id : l’identifiant du client
– vendor_id : l’identifiant du vendeur
– date_time : la date et l’heure de clôture de la vente

Vous pourrez ensuite utiliser l’API du logiciel de caisse Hiboutik pour récupérer les informations que vous souhaitez.
Ex: à partir de l’identifiant de vente, vous pouvez récupérer la liste des produits de la vente.

 

3/ Cas pratique: URL de callback & programme de fidélité

Dans Hiboutik les points fidélité sont enregistrés dans chaque fiche produit, et sont invariables à l’ajout d’un produit dans une vente.
Cela peut poser problème pour les commerces qui utilisent la fonctionnalité « prix libre » (saisie du prix des produits dans la vente), et qui souhaiteraient que les points fidélité soient proportionnels aux prix saisis.
Pour résoudre ce problème, la solution consiste à passer par l’API en effectuant un recalcul des points fidélité à la validation de la vente.

a/ Téléchargement et installation du script
Récupérez votre clé d’API dans « Paramètres/Utilisateurs/Utilisateurs » en cliquant sur l’icône clef de la ligne de votre utilisateur.
Téléchargez le script suivant et renseignez le libellé de votre compte, votre adresse email ainsi que votre clé API Hiboutik (lignes 20, 21 & 22):
https://github.com/hiboutik/hiboutikapi/blob/master/examples/fidelite.php
Installez le script sur votre hébergement et rendez le exécutable.

b/Configuration de l’URL de callback
Dans « Paramètres/Paramètres généraux », renseignez votre URL de callback qui correspond a l’adresse du script que vous venez d’installer.
ex: http://mondomaine.com/fidelite.php

A  présent, les points acquis par vos clients seront recalculés automatiquement à chaque clôture de vente.

le hibou a écrit 75 articles