Interroger les données en utilisant l'API wis2box
Résultats d'apprentissage
À la fin de cette session pratique, vous serez capable de :
- utiliser l'API wis2box pour interroger et filtrer vos stations
- utiliser l'API wis2box pour interroger et filtrer vos données
Introduction
L'API wis2box offre un accès à la découverte et à l'interrogation des données qui ont été ingérées dans wis2box de manière lisible par machine. L'API est basée sur la norme OGC API - Features et est implémentée en utilisant pygeoapi.
L'API wis2box donne accès aux collections suivantes :
- Stations
- Métadonnées de découverte
- Notifications de données
- plus une collection par jeu de données configuré, qui stocke les résultats de bufr2geojson (le plugin
bufr2geojson
doit être activé dans la configuration des mappages de données pour remplir les éléments de la collection de données).
Dans cette session pratique, vous apprendrez à utiliser l'API de données pour parcourir et interroger les données qui ont été ingérées dans wis2box.
Préparation
Note
Naviguez vers la page d'accueil de l'API wis2box dans votre navigateur web :
http://YOUR-HOST/oapi
Inspection des collections
Depuis la page d'accueil, cliquez sur le lien 'Collections'.
Question
Combien de collections de jeux de données voyez-vous sur la page résultante ? Que pensez-vous que chaque collection représente ?
Cliquez pour révéler la réponse
Il devrait y avoir 4 collections affichées, incluant "Stations", "Métadonnées de découverte" et "Notifications de données"
Inspection des stations
Depuis la page d'accueil, cliquez sur le lien 'Collections', puis cliquez sur le lien 'Stations'.
Cliquez sur le lien 'Parcourir', puis cliquez sur le lien 'json'.
Question
Combien de stations sont retournées ? Comparez ce nombre à la liste des stations dans http://YOUR-HOST/wis2box-webapp/station
Cliquez pour révéler la réponse
Le nombre de stations de l'API devrait être égal au nombre de stations que vous voyez dans l'application web wis2box.
Question
Comment pouvons-nous interroger pour une seule station (par exemple, Balaka
) ?
Cliquez pour révéler la réponse
Interrogez l'API avec http://YOUR-HOST/oapi/collections/stations/items?q=Balaka
.
Note
L'exemple ci-dessus est basé sur les données de test du Malawi. Essayez de tester avec les stations que vous avez ingérées dans le cadre des exercices précédents.
Inspection des observations
Note
L'exemple ci-dessus est basé sur les données de test du Malawi. Essayez de tester avec les observations que vous avez ingérées dans le cadre des exercices.
Depuis la page d'accueil, cliquez sur le lien 'Collections', puis cliquez sur le lien 'Observations météorologiques de surface du Malawi'.
Cliquez sur le lien 'Interrogeables'.
Question
Quel interrogeable serait utilisé pour filtrer par identifiant de station ?
Cliquez pour révéler la réponse
Le wigos_station_identifer
est l'interrogeable correct.
Naviguez vers la page précédente (c.-à-d. http://YOUR-HOST/oapi/collections/urn:wmo:md:mwi:mwi_met_centre:surface-weather-observations
)
Cliquez sur le lien 'Parcourir'.
Question
Comment pouvons-nous visualiser la réponse JSON ?
Cliquez pour révéler la réponse
En cliquant sur le lien 'JSON' en haut à droite de la page, ou en ajoutant f=json
à la requête API sur le navigateur web.
Inspectez la réponse JSON des observations.
Question
Combien d'enregistrements sont retournés ?
Question
Comment pouvons-nous limiter la réponse à 3 observations ?
Cliquez pour révéler la réponse
Ajoutez limit=3
à la requête API.
Question
Comment pouvons-nous trier la réponse par les observations les plus récentes ?
Cliquez pour révéler la réponse
Ajoutez sortby=-resultTime
à la requête API (remarquez le signe -
pour indiquer un ordre de tri décroissant). Pour trier par les observations les plus anciennes, mettez à jour la requête pour inclure sortby=resultTime
.
Question
Comment pouvons-nous filtrer les observations par une seule station ?
Cliquez pour révéler la réponse
Ajoutez wigos_station_identifier=<WSI>
à la requête API.
Question
Comment pouvons-nous recevoir les observations en CSV ?
Cliquez pour révéler la réponse
Ajoutez f=csv
à la requête API.
Question
Comment pouvons-nous afficher une seule observation (id) ?
Cliquez pour révéler la réponse
En utilisant l'identifiant de fonctionnalité d'une requête API contre les observations, interrogez l'API pour http://YOUR-HOST/oapi/collections/{collectionId}/items/{featureId}
, où {collectionId}
est le nom de votre collection d'observations et {itemId}
est l'identifiant de l'observation unique d'intérêt.
Conclusion
Félicitations !
Dans cette session pratique, vous avez appris à :
- utiliser l'API wis2box pour interroger et filtrer vos stations
- utiliser l'API wis2box pour interroger et filtrer vos données