Récupération des événements et données sur Ubiqod : le webhook

Récupération des événements et données sur Ubiqod : le webhook

La plateforme Ubiqod vous permet d'envoyer les données reçues par les trackers en temps réel à travers des webhooks. Découvrez dans cet article comment configurer ce connecteur.
Info
L'API REST Ubiqod permet d'accéder aux données de configuration des trackers, des badges, des sites... Elle donne notamment des informations utiles pour la gestion des trackers, comme par exemple la date et l'heure à laquelle des données ont été reçues et transmises pour la dernière fois. Cette API ne peut pas être utilisée pour récupérer les évènements et données.
La documentation API est accessible ici : https://api.ubiqod.com

Principe des webhooks

Lorsqu'un tracker envoie une donnée vers la plateforme et que cette donnée est valide, la plateforme envoie cette donnée en appellant une url en POST. Le contenu de ce POST (body / payload) contient les informations nécessaires à l'exploitation de cette donnée.

Exemple de payload

Un exemple de payload envoyée vers l'url de destination du webhook est consultable ici : https://storage.googleapis.com/skiply-prod-ubiqod/schemas/callbackexample_new.json

JSON Schema

Il permet par exemple de mapper automatiquement les champs disponibles dans certains systèmes comme Microsoft Power Automate.

Configuration des webhooks

Pour configurer un webhook, allez dans le menu connecteurs, et sélectionnez Webhook, dans la section Connecteurs génériques.

Configuration de l'URL de destination et des paramètres d'en-tête

L'URL du webhook définit l'adresse (appelée également parfois endpoint) du système qui recevra les données envoyées par le webhook :


Les paramètres d'en-tête seront transmis dans le header de la requête. Ils permettent par exemple d'ajouter une clef API, dont l'utilisation est fortement recommendée en production, afin d'éviter des injections de données malveillantes.

Filtrage des données (optionnel)

Les filtres permettent de limiter les données transmises en ajoutant des conditions de validité aux données

Autres options utiles

Mode compatibilité
Ce mode permet aux utilisateurs des versions antérieurs d'Ubiqod de continuer à recevoir des données au format précédent. Laisser désactivé pour une utilisation normale.

Limitation de traitement (rate limiting)
Cette option permet de fixer une limite d'envoi de données, notamment lorsque le système de destination est lui-même limité. Entrez 3 pour imposer un écart de 3 secondes entre 2 envois de données (les données ne seront pas perdues : elles seront mises en queue et envoyées selon le rythme configuré).

Rejeu des données manquées (IoT)
Pour les objets connectés compatibles, cette option permet de renvoyer des données lorsque le système détecte qu'une transmission a été manquée précédemment.

Test et debug

Politique de rejeu en cas d'échec

Si le serveur qui reçoit le webhook répond avec un code de statut autre que 2XX, Ubiqod réessaie automatiquement une fois après 60 secondes. Si la deuxième tentative échoue, une erreur est enregistrée dans les logs du connecteur. Vous pouvez configurer des alertes dans les paramètres de votre compte pour recevoir une notification par e-mail en cas d'échecs.

Traçabilité des données et logs

Il est possible de consulter l'ensemble des données envoyées à travers les webhooks, ainsi que la réponse du serveur de destination en utilisant les fonctionnalités de traçabilité de la plateforme. Vous trouverez également dans cet article les informations relatives à la durée de rétention des données techniques ainsi qu'aux possibilités de rejeu manuel des données en cas d'indisponibilité du système de destination.

    Essayez Ubiqod


    Recevez 100 crédits gratuits pour commencer sur Ubiqod: créer un compte

      • Related Articles

      • Introduction à la plateforme Ubiqod

        Ubiqod est une solution simple et flexible pour connecter les actions terrain à vos outils informatiques. La plateforme permet de collecter différentes données (pointages, demandes de service, localisations, enquêtes de satisfaction...) via des QR ...

      • Activer votre Ubiqod Key

        Introduction Lorsque vous recevez votre Ubiqod Key, l’écran est blanc et les piles ne sont pas insérées. Cette précaution permet d’éviter les phénomènes de rémanence sur l’écran et de préserver l’autonomie des piles pendant le transport. Veuillez ...

      • Ajouter un Ubiqod Key à votre compte Ubiqod

        Introduction Ubiqod Key est un QR code sécurisé et breveté conçu pour des applications nécessitant une sécurité renforcée. Avant de pouvoir l'utiliser sur la plateforme Ubiqod, il est nécessaire de l'ajouter à votre compte. Lors de l'achat d'un ...

      • Traçabilité des données reçues par les trackers et envoyées aux connecteurs

        L'interface "build" de la plateforme Ubiqod permet de configurer les trackers (objets connectés, QR codes...) pour envoyer leurs données à des systèmes tiers via des connecteurs. La plateforme intègre un système de traçabilité des données permettant ...

      • Gestion des utilisateurs dans Ubiqod

        Qu'est-ce qu'un utilisateur dans Ubiqod ? Un utilisateur dans Ubiqod est une personne physique qui accède à l’interface de gestion Ubiqod avec son adresse email. Lorsqu’un utilisateur créé son compte utilisateur, il est automatiquement rattaché à un ...