Utilisation des API dans Opendatasoft

Une API (Interface de Programmation d'Applications) 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 quel type d'accès ils ont.

Pour en savoir plus sur ce que sont les API et pourquoi et comment elles sont utilisées, vous pouvez lire l'article "Vous n'avez pas besoin d'analogies pour comprendre les API" écrit par l'un de nos développeurs Opendatasoft.

Opendatasoft fournit l'accès à cinq API :

• API ODS Explore V2 : Il s'agit de l'API principale d'Opendatasoft, utilisée pour explorer des catalogues et des jeux de données avec un langage de requête personnalisé similaire à SQL : ODSQL. L'API Explore vous donne accès aux données publiques sur la plateforme Opendatasoft. Pour plus d'informations, consultez Une introduction à l'API Explore, ou allez 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 s'assurer que les données publiées sur votre portail sont toujours à jour. Consultez Une introduction à l'API d'Automatisation pour plus d'informations, ou allez directement à la documentation de l'API d'Automatisation.

• WFS et CSW sont des normes axées sur les données géographiques. Voir ici pour une introduction à WFS, ou allez directement à la documentation de WFS. Elles sont particulièrement pertinentes, 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 à travers les API pour effectuer des requêtes. Le compromis de l'approche générique de cette norme est sa complexité plus élevée par rapport aux API REST personnalisées traditionnelles. Opendatasoft a mis en œuvre cette norme pour les opérations simples (recherche des jeux de données et d'enregistrements) ; pour les opérations 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 de motifs triples sur des jeux de données provenant des portails Opendatasoft. Elle permet de requêter des jeux de données au format Resource Description Framework (RDF). Consultez la documentation de l'API Triple Pattern Fragments (TPF).

Toutes ces API fournissent un accès à toutes les données publiées sur la plateforme, quelle que soit leur source ou leur format, tant 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 données et des jeux de données, pour effectuer des analyses, ou pour réaliser des agrégations géographiques, ou même pour permettre à des tiers de réutiliser des données sur votre portail. Certains clients d'Opendatasoft ont vu des jeux 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 de cantine scolaire dans les villes françaises de Toulouse, Rennes et Saint-Malo, basées sur des données fournies sur les portails Opendatasoft.

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

La plateforme Opendatasoft peut être vue comme un réseau de portails Opendatasoft. Un portail fournit un catalogue de tous 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.