Utiliser les API dans Opendatasoft

Patrick Smith Mis à jour le par Patrick Smith

Une API, ou interface de programmation d'application, est une interface permettant aux programmes de communiquer et d'échanger des données. Si vous souhaitez utiliser des données stockées quelque part en ligne, une API vous permet d'interagir avec ces données d'une manière que la source comprendra. Et si vous souhaitez partager vos données avec d’autres, une API vous permet de définir le type d’accès dont ils disposent.

Pour en savoir plus sur ce que sont les API et pourquoi et comment elles sont utilisées, vous pouvez lire l'article « You don’t need analogies to understand APIs » (Pas besoin d'analogies pour comprendre les API) écrit en anglais par l'un de nos développeurs Opendatasoft.

Opendatasoft propose cinq API :

  • ODS Explore API V2 : Il s'agit de l'API principale d'Opendatasoft, utilisée pour explorer des catalogues et des ensembles de données avec un langage de requête personnalisé de type SQL : ODSQL. L'API Explore vous donne accès aux données publiques sur la plateforme Opendatasoft. Pour plus d'informations, consultez Introduction à l'API Explore ou passez directement à la documentation de l'API Explore.
  • API d'automatisation : Cette API peut être très utile pour automatiser vos processus de gouvernance des données et vous assurer que les données publiées sur votre portail sont toujours à jour. Voir Introduction à l'API Automation pour plus d'informations, ou bien accédez directement à la documentation de l'API Automation.
  • WFS et CSW sont des normes axées sur les données géographiques. Voir ici pour une introduction à WFS , ou bien allez directement à la documentation WFS. Ils sont particulièrement pertinents, par exemple, pour interfacer la plateforme avec d'autres logiciels SIG.
  • OData est une norme pour les API REST qui fournit un langage commun à utiliser entre les API pour exécuter des requêtes. Le compromis de l'approche générique de cette norme est sa plus grande complexité par rapport aux API REST personnalisées traditionnelles. Opendatasoft a implémenté cette norme pour les opérations simples (recherche de jeux de données et d'enregistrements) ; pour les plus complexes (analyses, agrégations, calculs géographiques, etc.), utilisez notre API Explore V2.
  • API Triple Pattern Fragments : Il s'agit d'une API ODS pour les requêtes triples modèles sur des ensembles de données à partir des portails Opendatasoft. Il permet l'interrogation d'ensembles de données au format Resource Description Framework (RDF). Consultez la documentation de l'API Triple Pattern Fragments (TPF).

Toutes ces API donnent accès à toutes les données transmises sur la plateforme, quelle que soit leur source ou leur format, à condition que les règles de sécurité définies par le propriétaire de ces données vous permettent d'avoir cet accès.

Ces API peuvent être utilisées, par exemple, pour rechercher des ensembles de données et des données, pour effectuer des analyses, ou pour effectuer des agrégations géographiques, ou encore pour permettre à des tiers de réutiliser des données sur votre portail. Certains clients d'Opendatasoft ont vu les ensembles de données qu'ils fournissent utilisés pour créer des applications. Par exemple, « Qui dit miam ! » et « Y'A D Frites ! » sont deux applications qui affichent les menus des repas scolaires dans les villes françaises de Toulouse, Rennes et Saint-Malo, sur la base des données fournies sur les portails Opendatasoft.

Comment les données Opendatasoft sont structurées

Avant d'utiliser l'une des API disponibles, il est très important de se familiariser avec la façon dont les données sont structurées. Tout au sein de la plateforme Opendatasoft est construit selon une arborescence (il existe plus de types de données au sein de la plateforme, mais elles ne sont pertinentes que dans des contextes très spécifiques).

La plateforme Opendatasoft peut être considérée comme un réseau de portails Opendatasoft. Un portail met à disposition un catalogue de l'ensemble de ses jeux de données. Chaque jeu de données est défini par un dictionnaire de métadonnées, un schéma de données (spécifiant les noms et types de champs) et une collection d'enregistrements. Chaque enregistrement fournit des valeurs pour chacun des champs du jeu de données.

Êtes-vous satisfait ?

Illustrer vos données

Contactez-nous

Powered by HelpDocs (opens in a new tab)