Données API REST
Last updated
Last updated
Dans ce menu, vous pouvez importer des données externes, ne provenant pas de vos modules en utilisant des API.
Cas d'utilisation : cette fonctionnalité permet au client d'exploiter des données que ses capteurs personnels ne fournissent pas, par exemple les données météorologiques en temps réel de la station météo la plus proche de son site.
Pour ajouter une API, cliquer le bouton "Ajouter une API REST". Renseigner ensuite le nom de votre API ainsi que son URL d'accès.
L'URL prend en charge les paramètres, ils doivent être notés sous la forme
Une fois que l'API a été ajoutée, il faut la configurer pour pouvoir utiliser les valeurs reçues.
Sur la première fenêtre simplement intitulée REST API, il est possible de modifier l'URL et le nom de l'API que nous avons décidé précédemment.
Afin de configurer la méthode de connexion à l'API, accédez à l'onglet « Authentification ». Vous y trouverez trois options d'authentification pour sécuriser l'accès à votre API.
Pas d'authentification.
Certaines API ne demandent pas d'authentification, dans ce cas choisissez l'option "Pas d'authentification"
Bearer token
Un bearer token est un jeton d'accès (souvent une chaîne de caractère) fournit par le propriétaire de l'API. Pour le configurer, rendez vous encore une fois dans l'onglet authentification (2) sélectionnez l'option de connextion Bearer token (3) et copier dans le champ de texte vide votre jeton d'accès (4).
Ajouter des paramètres dans l'en-tête de la requête.
Enfin il vous est également possible de vous authentifier auprès de l'API directement en ajoutant des paramètres dans l'en-tête de la requête.
Attention : dans la suite de cette page, les noms que vous attribuerez à vos paramètres ou variables sont importants. Choisissez-en un qui reflète clairement les informations auxquelles ils se réfèrent.
Nom de l'API
Nom du paramètre "Paramètre avancé"
Nom de là Variable
Type de là variable.
C'est sur cette page que vous attribuez des valeurs aux paramètres renseignés dans l'URL. Pour ce faire, cliquez le bouton "Ajouter une propriété" et remplissez les paramètres avec les informations dont vous avez besoin.
Ces paramètres peuvent être définis soit par une variable (1), soit par une constante (2). Par exemple, les variables peuvent représenter des données telles que des dates.
L'ajout d'une variable sur cette page permet vous de définir des variables de projet en utilisant des données provenant du JSON de réponse de l'API précédemment ajoutée. Ces variables sont liées à des éléments spécifiques du JSON, créant ainsi des références entre les variables et leurs sources de valeurs. Pour créer vos variables, cliquez dans un premier temps sur le bouton "Ajouter une variable"
Une fois sur l'interface de création, il faut :
Nommer la variable
Donner un type à cette variable (Le type de la variable qu'on recherche dans le JSON)
Il faut ensuite dire notre variable de projet où trouver sa valeur, la variable source. Pour cela on précise dans l'onglet "Renseignez le chemin pour accéder à la valeur ciblée" le chemin d'accès vers la variable dans le Json. Exemple :
Enfin, Il est possible de modifier la date d’une donnée via l'API. En effet, la date de relevé de la donnée peut différer de celle de sa réception. Ainsi, vous pouvez utiliser la date de relevé plutôt que la date de réception de la donnée pour plus de précision.
Pour vérifier que vos variables et paramètres sont bien configurées, rendez-vous sur le tableau d’acquisition de données et recherchez si vos variables sont bien présentes.
