Callback

Utilisez les callbacks afin d'être notifié lors d'une modification sur un objet

Un événement peut correspondre à une création de commande (order), de réservation (booking), de caisse (till) ou une modification. Pour fonctionner un callback nécessite un endpoint (URL unique) définie lors de la configuration qui recevra l'ensemble des événements.

Pourquoi utiliser les callback

Les callback permettent de recevoir les différentes modifications apportés à un objet que vous avez créé à travers l'API. Pour une commande par exemple, les callback vous permettent de recevoir une notification lorsque des produits y sont ajoutés ou bien lorsque celle-ci est annulée ou clôturée.

Recevoir des callback

Un callback a besoin d'une URL comme endpoint. Toutes les requêtes seront envoyées à travers une requête HTTP de type POST

Sécurisation des callbacks

Les requêtes sont protégée par un système de basic auth qui permet de vérifier la provenance de la requête. Lors de la configuration des callback un login et un mot de passe seront demandés.

Gestion des cas d'erreurs

Dans le cas où le endpoint ne répond pas correctement (réponse HTTP 2xx) aucun essai ne sera retenté (non supporté pour le moment).

Format d'un événement

JSON

{
  "id": 42,
  "type": "ORDER_CLOSED",
  "storeID": 42,
  "data": {
  		"id": 42,
      "status": "CLOSED",
       …
  }
}

L'objet data constitue la donnée propre à chaque type d'objet

Objet	Documentation
Order	/orders
Booking	/orders/booking
Till	/tills
Restaurant	/restaurant

Types d'événements

Les différents types d'événements supportés sont les suivants

Objet	Type	Description
Order	ORDER_CLOSED	Intervient lorsque la commande a été clôturée
Order	ORDER_CANCELED	Intervient lorsque la commande a été annulée
Restaurant	RESTAURANT_UPDATED	Intervient lorsque l'établissement est modifié
Restaurant	RESTAURANT_INFO_UPDATED	Intervient lorsque les informations de configuration de l'établissement sont modifiées (Tax, Inventaire, Utilisateurs…)