Au travers de l'API Data v1, intentPlatform vous permet de transmettre 2 types de données sur intentPlatform :
Mesures
Evénements - alertes
Qu'est ce qu'un stream ?
Un stream est un flux de données ayant des caractéristiques (référence, titre, unité, type, etc.).
Si vous souhaitez transmettre des mesures, vous devrez créer à minima 1 flux metrics. Mesures
Si vous souhaitez transmettre des événements-alertes, vous devrez créer à minima 1 flux events. Evénements et alertes
Transmettre des données
La transmission des données sur intentPlatform se déroule en 2 étapes :
.1Création du stream
.2Alimentation du stream en données
Création du stream
La 1ère étape avant tout envoi de données est la création d’un ou plusieurs streams (flux de données). L’intégralité des informations pour créer un flux de données est disponible dans notre documentation en ligne.
Il est fortement conseillé d’attacher le stream à un élément de patrimoine. Le rattachement du flux à un élément de patrimoine permettra aux utilisateurs de bénéficier de toutes les fonctionnalités sur intentPlatform (navigation simplifiée, indicateurs, filtres, alerting, etc.).
Un flux peut aussi bien être relié à un élément de type bâti (logement, résidence...) qu'à un équipement (ascenseur, chaudière...) en fonction de ce qui a été convenu avec le client.
Cette association se fait via le champ intent_assetReference.
Cette référence d'asset doit être la référence du client.
Cette référence d'asset reste unique tout au long du cycle de vie du flux, de cette manière si la source de données change (par exemple remplacement de capteurs), le flux reste unique sur Intent.
Partage des données au client
Afin de partager le stream à un tiers (gestionnaire immobilier par exemple), il vous faudra indiquer une référence de contrat dans le champ intent_contractReference.
La référence du contrat doit être définie au préalable afin qu'Intent puisse la paramétrer dans la plateforme.
Description du flux
Afin d'améliorer l'expérience utilisateur, nous vous conseillons d'indiquer un label permettant de décrire rapidement le flux pour l'utilisateur. Par exemple : "Etat de fonctionnement de l'ascenseur 12 Boulevard de la liberté".
Celui ci doit être indiqué dans le champ label
Le champ descriptionpeut également être utilisé dans un second temps si vous souhaitez ajouter plus de détails sur le stream.
Définition du type de données envoyées
L'activité mesurée par les données du stream est à indiquer dans le champ intent_activityKey
Si toutefois, une de vos activités n’est pas gérée par intentPlatform, vous pouvez contacter le service client d’Intent Technologies afin d’en étudier sa création.
Fréquence
La fréquence (intent_frequency) correspond au pas de mesure et non à la fréquence d’envoi des données. Elle s’exprime en minutes. Par exemple, un objet connecté peut mesurer la température d’air intérieur toutes les heures et transmettre ces données 2 fois par jour. La fréquence sera donc égale à 60 (minutes).
Si vous transmettez des relevés d’index manuels, des mesures effectuées de façon ponctuelles ou des événements d'alertes, il vous faut soit indiquer une fréquence = 0 ou alors ne rien indiquer.
Tag deviceId
Les données transmises peuvent provenir d’objets connectés. Vous pouvez indiquer la référence du capteur fournissant la donnée dans un tag libre. Nous vous recommandons de nommer le tag “deviceId”.
Informations facultatives
Vous pouvez ajouter toute autre information qui vous semble pertinente pour la création du stream dans des tags libres.
Alimentation du stream en données
Une fois vos streams créés, vous pouvez les alimenter en données.