API REST : Webhooks

callback-url

 

Un Webhook (également appelé 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 envoie les informations relatives à la vente validée au Webhook Ventes que vous avez spécifié.
Il est possible de définir différents Webhooks en fonction de l’action réalisée. Le paramétrage s’effectue dans la section « Paramètres/Paramètres généraux » de votre compte Hiboutik.

 

1/ Pourquoi les Webhooks ?

Le Webhook 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.

Ainsi, il n’est plus nécessaire d’interroger régulièrement l’API de votre compte pour savoir si l’action s’est réalisée. C’est Hiboutik qui vous tient informé lorsque l’action est déclenchée. Vous économisez des ressources (appels API) et vous gagnez du temps (retour d’informations immédiat).

 

2/ Les Webhooks dans Hiboutik

Les Webhooks sont propres à chaque point de vente. Ainsi dans un compte multi-boutiques, vous pourrez définir des Webhooks différents par point de vente pour une action en particulier.

Les actions qui peuvent être liées à un Webhook 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 au Webhook sont au format JSON, et sont propres à chaque action.
Par exemple, le Webhook Ventes récupérera le détail exhaustif de la vente :
– Informations sur le client et ses coordonnées,
– Liste des produits vendus avec leurs informations spécifiques (code-barres, description…),
– Répartition des taxes et les totaux,
– Modes de paiement et leurs échéances,
– Ainsi que toutes les informations spécifiques à la vente (commentaires, vendeur, statut,…).

Si vous souhaitez obtenir des informations complémentaires, vous pouvez également interroger directement l’API de votre compte.

 

3/ Cas pratique: Webhook & 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 vos identifiants API dans « Paramètres/Utilisateurs/API ».
Téléchargez le script suivant et renseignez le libellé de votre compte, votre adresse email ainsi que votre clé API (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 du Webhook
Dans « Paramètres/Paramètres généraux », renseignez votre Webhook Ventes 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 la vente.

 

Vous l’aurez compris, les Webhooks sont des outils très puissants qui vont vous permettre de simplifier l’intégration de votre logiciel de caisse Hiboutik dans votre propre environnement logiciel.

le hibou a écrit 83 articles