Présentation de l'API WFS

Modifié

Cet article est une brève introduction aux principales utilisations de l'API WFS. Si vous êtes déjà familiarisé avec les API et l'API WFS, vous pouvez accéder directement à la documentation WFS. Sinon, lisez la suite pour plus de détails !

Une API, ou interface de programmation d'applications, est un outil conçu pour permettre à différents systèmes logiciels de communiquer entre eux. Si vous souhaitez utiliser des données stockées quelque part en ligne, l'objectif d'une API est de vous permettre d'interagir avec ces données d'une manière compréhensible par la source. 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.

Opendatasoft fournit plusieurs API différentes pour interagir avec la plateforme, mais l'API Opendatasoft WFS vous donne accès aux données géographiques publiques sur la plateforme Opendatasoft.

Ce que l'API WFS vous permet de faire

Pour interagir avec l'API, vous effectuez un soi-disant appel API. Un appel est lorsque vous visitez l'URL appropriée, avec la demande que vous faites spécifiée dans l'URL. L'API récupère ensuite ces informations et les renvoie à votre navigateur.

En incluant l'une des commandes suivantes en gras dans l'appel d'API, l'API WFS vous permet d'effectuer trois actions principales :

  • GetCapabilities : Récupère les métadonnées du service WFS.

  • DescribeFeatureType : Génère une description du schéma pour les types de fonctionnalités pris en charge par le service.

  • GetFeature : récupère les données d'un jeu de données et les restitue à l'aide de la représentation GML.

Voir la section ci-dessous pour chacun pour un exemple de la syntaxe appropriée à utiliser.

Les exemples sur cette page sont basés sur un jeu de données de pays européens et leurs notes en matière d'égalité des sexes. Et pour visualiser les données, nous utiliserons QGIS, une application populaire pour visualiser, afficher et analyser des données géospatiales.

GetCapabilities

GetCapabilities est l'une des trois actions principales que vous pouvez effectuer avec l'API WFS. Cette action répertorie les jeux de données d'un domaine et ses fonctionnalités associées.

Il a deux paramètres obligatoires :

  • Service : "WFS"

  • Demande : "GetCapabilities"

L'URL de cette requête est donc : https://documentation-resources.opendatasoft.com/api/wfs?service=wfs&request=getcapabilities

La section "FeatureTypeList" affiche les jeux de données disponibles dans le domaine :

DescribeFeatureType

Cette action permet principalement de décrire le schéma d'un jeu de données en fonction de son nom de type.

Dans WFS, le "typename" est l'identifiant d'un jeu de données. Dans l'exemple de GetCapabilities ci-dessus, l'un des ensembles de données de l'espace de travail "documentation-resources" avait le nom de type : "ods:gender-equality-in-europe". Nous l'utiliserons dans l'exemple ci-dessous.

Cette action a quatre paramètres obligatoires :

  • Service : "WFS"

  • Demande : "DescribeFeatureType"

  • Version : "2.0.0"

  • Typename : "ods:gender-equality-in-europe "

L'URL de cette requête est donc : https://documentation-resources.opendatasoft.com/api/wfs?service=wfs&request=describefeaturetype&version=2.0.0&typename=ods:gender-equality-in-europe

Comme vous pouvez le voir sur l'image, les éléments répertoriés par cette requête sont "country", "country_zip", "general_index", etc. Celles-ci correspondent aux colonnes du jeu de données "ods:gender-equality-in-europe".

GetFeature

Cette opération vous permet principalement de récupérer les données d'un jeu de données en fonction de son nom de type. N'oubliez pas que dans WFS, le "typename" est l'identifiant d'un jeu de données.

Il a quatre paramètres obligatoires :

  • Service : "WFS"

  • Requête : "GetFeature"

  • Édition : "2.0.0"

  • Typename : "ods:gender-equality-in-europe"

L'URL de cette requête est donc : https://documentation-resources.opendatasoft.com/api/wfs?service=wfs&request=getfeature&version=2.0.0&typename=ods:gender-equality-in-europe

Ainsi, les éléments renvoyés par cette requête correspondent aux données du jeu de données "ods:gender-equality-in-europe" . Chaque ligne du jeu de données correspond à un membre (<wfs:member>).

Un exemple d'utilisation de l'API WFS de QGIS

Une utilisation courante consiste à générer une visualisation intéressante de nos données à l'aide de logiciels de visualisation géographique tels que QGIS, ArcGIS, MapInfo Professional, GRASS GIS, etc.

  1. ​Ouvrez le Data Source Manager​, ajoutez une couche OpenStreetMap, puis créez une nouvelle connexion WFS

  1. Ajoutez l'URL de votre domaine suivi de /api/wfs, utilisez la version 2.0.0

  1. Ajouter le jeu de données en tant que couche

  1. Modifiez les propriétés pour ajouter un dégradé et ajuster sa colonne de référence

  1. Utilisez, interprétez, explorez et partagez votre visualisation

Ici, nous avons précisé au logiciel la colonne significative general_index pour le gradient, qui représente la note moyenne attribuée à un pays. Ainsi, nous avons une meilleure représentation des inégalités de genre en Europe par rapport à une vue tabulaire.

Et ensuite ?

Espérons que cette page aide à expliquer comment l'API WFS peut vous être utile.

L'utilisation d'une API n'est peut-être pas pour tout le monde. Cependant, avec un petit effort, l'API peut vous aider à mieux comprendre et à utiliser efficacement vos propres données ainsi que d'autres données publiques.

Pour vous accompagner tout au long de votre chemin, nous vous invitons à vous plonger dans notre documentation sur l'API WFS !