< Retour

Introduction aux API

Une introduction au monde des APIs et leurs utilisations dans nos applications de tous les jours.

Matériel utilisé pour ce projet

Une API, qu'est-ce que c'est ?

Une API, en français "Interface de programmation applicative", est une interface simplifiée permettant à des logiciels de communiquer entre eux.
Par exemple, le système d'API permet  d'afficher les données météorologiques du site OpenWeatherMap sur la page Météo de Vittascience.

Pour comprendre comment cela fonctionne, il faut imaginer que lorsque vous cliquez sur la carte, un événement se déclenche et appelle l'API de OpenWeatherMap, qui répond en retour un ensemble de données météorologiques correspondant à la localisation cliquée.

L'interface de programmation de Vittascience permet de mettre en place une API très simplement. Avec celle-ci, il est possible de partager les données acquises par les capteurs, par exemple pour les afficher sur un site internet tiers.

Programmer ma première API

L'API Vittascience requiert une clé par utilisateur, qui assure la confidentialité des données et permet d'éviter les abus. Il faut donc commencer par se connecter à votre compte Vittascience. 

Notre API envoie de nouvelles données toutes les 10 secondes, via l'outil "Graphique". De ce fait, pour obtenir des données de l'API, il faut utiliser le bloc "Traceur Série". Commençons par un programme simple qui affiche le temps en secondes depuis le transfert vers la carte électronique.
Transférer le programme ci-dessous vers la carte, puis aller dans le "Mode Graphique" en bas à droite. Sur ce mode, cliquer sur le bouton exporter et aller dans l'onglet API. Si vous êtes connecté-e, vous allez obtenir un lien de cette forme :


Ce lien contient votre clé personnelle servant à obtenir les données de votre projet. Copier ce lien, puis cocher la case "Activer l'API sur ce projet".

Récupérer les données

Une fois l'API activée, les données sont envoyées sur le serveur de Vittascience et deviennent accessibles à l'aide de votre clé d'API. Ces données restent privées et ne sont en aucun cas accessible par un tier.

Ouvrir un nouvel onglet dans le navigateur et coller le lien contenant la clé.
Le fichier de sortie contient plusieurs éléments au format JSON :
  • Une clé 'success' qui indique le succès ou non de la récupération des données. (true/false)
  • Une clé 'data' qui contient l'ensemble des données reçues par rapport au projet.
  • une clé 'lastUpdate' qui donne la date des informations reçues.
  • une clé 'error' qui, en cas de problème lors de la récupération des données, fournit un message d'erreur expliquant la raison.
Vous pouvez ainsi visualiser les données sur votre ordinateur, mais également sur votre téléphone ou n'importe quel appareil connecté à internet.
A l'heure actuelle, il n'y a pas d'options avancées pour l'API, ni de gestion de multi-projets.
Vous pouvez faire autant d'appel à cette API que vous le souhaitez, mais les données n'étant rafraîchies que toutes les 10 secondes, il n'est pas utile d'y faire appel plus souvent.En cas de perte ou d'utilisation frauduleuse de votre clé d'API, vous pouvez en regénérer une dans l'onglet "Mes programmes" de votre compte. L'ancienne clé sera immédiatement désactivée sur l'ensemble de vos projets.

À vous de jouer

Vous savez maintenant comment fonctionne l'API et comment récupérer les données.
À vous de créer un programme pour partager les données que vous souhaitez !