API Hub
Sachez ce qu’il faut avant d’appeler une API.
Pour chaque version, consultez la méthode d’authentification, la documentation technique et les mesures disponibles, avec leur auteur et leur date.
Données par version
Authentification et documentation sont consignées pour chaque version.
Deux versions d’une même API peuvent utiliser des méthodes d’authentification différentes. Ces données suivent donc chaque version et indiquent leur source.
Authentification
Sans authentification, par clé API ou par autorisation utilisateur. Chaque version garde son propre relevé, même si la méthode change.
Documentation technique
La fiche indique où se trouve la documentation, qui l’a fournie et quand elle a été vérifiée.
Mesures
Chaque mesure comprend l’indicateur, la méthode, les conditions, l’unité et la date.
Sources
Chaque donnée précise si elle vient du fournisseur, de données publiques importées ou d’une mesure de la communauté. Les données importées incluent un lien vers leur source et leur licence.
Une mesure et une note sont deux choses différentes. Une note exprime un avis ; une mesure indique ce qui a été observé et dans quelles conditions.
Mesures
Cinq informations pour comprendre une mesure.
Lisez l’indicateur, la méthode, les conditions, l’unité et la date. Pour comparer les résultats, vérifiez aussi leur objet et leur périmètre.
Indicateur
Ce qui est mesuré.
Méthode
La méthode utilisée.
Conditions
Les circonstances de la mesure.
Unité
L’unité de la valeur mesurée.
Date
Le jour de la mesure. Les anciens résultats conservent leur date.
Les résultats d’un même indicateur forment un historique et peuvent être comparés à ceux d’autres API.
Données absentes
Inconnu, zéro et sans objet sont trois réponses distinctes.
Une donnée non mesurée est inconnue, pas égale à zéro. Un indicateur sans objet n’est pas traité comme une donnée manquante. Une absence de données ne devient pas une note trompeuse.
Vérifiez l’authentification avant de commencer l’intégration.
Utilisez un seul compte pour trouver des API, suivre leurs versions et partager vos retours d’intégration.