Utiliser l’API

Une API (Application Programming Interface, interface de programmation applicative) est une interface permettant aux programmes de communiquer et d’échanger des données.

Note

Pour en apprendre davantage sur les API et leur utilisation, vous pouvez consulter l’article “You don’t need analogies to understand APIs (Pas besoin d’analogies pour comprendre les API - article en anglais)” écrit par l’un de nos développeurs OpenDataSoft.

OpenDataSoft met à votre disposition 6 API pouvant être classées en 3 catégories :

Toutes ces API permettent d’accéder aux données envoyées à la plateforme, quels que soient leur source ou leur format, dans la mesure où les règles de sécurité définies par le propriétaire des données autorisent cet accès.

Ces API peuvent par exemple être utilisées pour rechercher des jeux de données et des données, effectuer des analyses ou encore des agrégations géographiques. Autre exemple, toujours orienté développeurs, mais plus concret, de ce que vous pouvez faire avec les API : réutiliser des données pour créer des applications. Les données de certains clients d’OpenDataSoft ont en effet été réutilisées via leurs API pour créer des applications (par exemple, Qui dit miam ! et Y’A D Frites! 2 applications qui affichent le menu des cantines scolaires dans les villes françaises de Toulouse, Rennes et Saint-Malo).

Rappel avant d’aborder les spécifications des API

Avant d’utiliser l’une des API disponibles, il est primordial que vous connaissiez la nature de ces données. Tous les éléments au sein de la plateforme sont conçus par rapport à une arborescence (bien entendu, davantage de types de données résident dans la plateforme, mais elles sont uniquement pertinentes dans des contextes très spécifiques). OpenDataSoft peut donc être représenté comme suit :

  • La plateforme OpenDataSoft est 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 (qui spécifie les noms et les types de champs) et une collection d’enregistrements.

  • Chaque enregistrement fournit des valeurs pour chacun des champs du jeu de données.

Triple Pattern Fragments

L’API Triple Pattern Fragments (TPF) permet d’interroger les jeux de données au format Resource Description Framework (RDF). Cette API est toujours en cours de développement et s’inscrit dans une thèse visant à améliorer la qualité des jeux de données OpenDataSoft à l’aide des technologies du web sémantique.

OData, WFS et CSW

OData, WFS et CSW désignent les autres normes mises en œuvre par la plateforme. Nous recommandons aux utilisateurs qui ne connaissent pas ces 3 API d’utiliser l’API ODS Search, car elle offre l’accès aux données le plus complet.

  • OData: norme pour les API REST qui offre un langage commun pouvant être utilisé avec les différentes API, afin d’effectuer des demandes. L’approche générique de cette norme présente l’inconvénient d’être plus complexe que les API REST personnalisées classiques. OpenDataSoft a mis en œuvre cette norme pour les opérations simples (la recherche de jeux de données et d’enregistrements) ; pour les opérations plus complexes (l’analyse, les agrégations, les calculs géographiques, etc.), nos API ODS Search (v1 et v2) doivent être utilisées.

  • WFS et CSW: normes portant sur les données géographiques. Elles sont particulièrement utiles pour créer une interface entre la plateforme et d’autres logiciels GIS par exemple.