Fonctionnalité avancée : cette fonctionnalité est recommandée aux utilisateurs avancés uniquement et nécessite un codage.
Qu'est-ce qu'un webhook ?
Un webhook permet à une application de fournir à d'autres applis des informations en temps réel. Un webhook fournit des données à d'autres applications au fur et à mesure, ce qui signifie que vous obtenez des données immédiatement. Cela diffère d'une API classique, où vous devez demander des données très fréquemment pour les obtenir en temps réel. Les webhooks sont donc beaucoup plus efficaces et, dans la plupart des cas, constituent une meilleure option.
Quand dois-je utiliser un webhook ?
Si vous souhaitez envoyer des données à chaque fois qu'un nouveau billet est acheté sur Universe vers votre serveur ou une autre application qui n'est pas prise en charge par notre intégration zapier, alors vous devez utiliser un webhook.
Quand ne dois-je pas utiliser un webhook et devrais-je plutôt utiliser l'API ?
Si vous souhaitez que les données ne soient envoyées que lorsque vous lancez la demande, et que vous voulez limiter la réception à un sous-ensemble de données.
De quoi ai-je besoin pour utiliser un webhook ?
Pour utiliser un webhook, vous devez disposer d'un outil capable de consommer le webhook. Vous devrez donc être capable d'écrire du code ou obtenir l'aide de quelqu'un qui le fait.
Que dois-je savoir à propos d'un webhook Universe ?
Lorsqu'un billet est acheté, nous envoyons une requête HTTP POST
codée en JSON
à l'URL de la charge utile (payload) fournie avec les en-têtes suivants :
X-Uniiverse-Event - Type d'événement
X-Uniiverse-Signature - HMAC hex digest de la charge utile, en utilisant le secret du crochet comme clé (si configuré).
Le corps de la demande sera une représentation codée en JSON
des données.
Pour commencer :
1. Configuration du webhook
Accédez à la rubrique « Paramètres » de votre compte Universe.
2. Dans l'onglet « compte », descendez jusqu'à la section « webhooks » et cliquez sur « Ajouter un webhook ».
3. Configurer le webhook
Pour configurer le webhook, vous devez remplir les champs suivants :
URL : il s'agit de l'URL de votre service web, ou de ce que vous avez mis en place pour consommer la requête POST.
Si vous souhaitez simplement le tester, vous pouvez utiliser une URL RequestBin (depuis https://requestbin.com/) pour envoyer temporairement les données d'Universe et examiner le format des données.
Secret : un secret est comme un mot de passe utilisé entre Universe et votre application, pour empêcher d'autres applis d'accéder à vos données.
Actif : vous devez cocher cette case si vous souhaitez activer le webhook. Vous pouvez activer et désactiver votre webhook à tout moment.
4. Écrire du code pour consommer les données
Chaque fois qu'un nouveau billet est acheté, Universe envoie toutes les données dont vous avez besoin concernant l'événement et l'achat pour les intégrer dans votre application.
Vous pouvez consulter un exemple de demande contenant toutes les données que nous envoyons ici.
Vous trouverez une explication de chaque objet à l'adresse suivante http://developers.universe.com
Événements
Actuellement, deux événements peuvent déclencher un webhook :
ticket_purchase
- Chaque fois que vous achetez un billet ou qu'un billet est acheté pour l'un de vos référencements.
ticket_update
- Chaque fois que l'état du billet change (par ex. passe de payé à annulé, etc.).
Remarque : ces événements partagent les mêmes données.
Dépannage
Si, pour une raison quelconque, la requête POST vers l'URL de la charge utile échoue, le webhook sera marqué comme inactif et vous devrez le réactiver à partir de vos paramètres utilisateur.
Commentaires
0 commentaire
Cet article n'accepte pas de commentaires.