Documentation

Cette page décrit l'ensemble des services web permettant d'accéder aux données sur le niveau des nappes.

Origine des données

Ces données sont issues de la banque ades.eaufrance.fr ; Il s'agit des chroniques de hauteur d'eau dans les piézomètres.

Les métadonnées sont disponibles à :

http://www.data.eaufrance.fr/jdd/3bd466a1-08e0-4341-8e8e-8f880a19df6f

Les données sont mises à jour au fil de l'eau dans ADES, et une fois par semaine (le lundi matin) dans hubeau.

Exposition des données

Les données sont exposées sous la forme d'une API REST, les formats supportés sont : JSON, GeoJSON et CSV.

Pour plus d'informations sur les conditions d'utilisations, vous pouvez consulter la FAQ et les conditions générales d'utilisations.

Pour vos questions et remarques, utilisez notre forum.

Derniers changements

29/11/2017 :
- mise à jour de la version de l'API, passage de v0 à v1, modification de l'URL de l'API : /v0/niveaux_aquiferes par /v1/niveaux_nappes, pour plus d'information cf http://hubeau.eaufrance.fr/page/api-piezometrie-depreciee
- ajout de dans la réponse de l'attribut api_version (string) : version de l'API (https://semver.org/)
04/10/2017 : ajout du paramètre "sort" sur l'opération "chroniques", permet de changer l'ordre de tri (asc ou desc) sur la date de mesure piézométrique
04/05/2017 : mise à jour de l'adresse de l'API api.hubeau.fr vers hubeau.eaufrance.fr/api/
24/11/2016 : ajout de l'attribut "timestamp_mesure" sur l'opération "chroniques" de l'API sur le niveau des aquifères
21/09/2016 : ajout des libellés SANDRE à côté des codes SANDRE dans la réponse
08/08/2016 : ajout du paramètre fields, la valeur est une liste des champs souhaités dans la réponse (fonctionnalité expérimentale), par exemple fields=code_station,localisation

Accès

L'API Hub'Eau est accessible en http et https :

http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=62193&format=json&pretty

https://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=62193&format=json&pretty

 

Pour gérer le cross-domain, l'API Hub'Eau supporte le protocole Cross Origin Resource Sharing (CORS) et pour les anciens navigateurs le JSONP avec le paramètre callback :

http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=62193&format=json&callback=jquery12&pretty

Pagination

Les méthodes sont paginées et suivent le même modèle de pagination.
Les paramètres de pagination sont :
- page : le numéro de page
- size : la taille de la page

Vous n'avez pas à calculer vous-même les pages précédentes et suivantes puisque les URL sont disponible dans la réponse dans les attributs prev et next. Ils seront définis à null si il n'y a pas de page précédente et/ou suivante.
L'attribut first permet d'accéder à la 1er page des résultats, l'attribut last permet d'accéder à la dernière page des résultats et l'attribut count le nombre total de résultat.
Les résultats sous forme de liste sont dans l'attribut data.

Limitations

Les résultats sont paginés avec une valeur par défaut et une valeur maximum de taille de page pour chaque opération.
Cette information est indiqué dans les commentaires de l'opération, exemple :
"La taille de page par défaut : 5000, taille max de la page : 20000."

La longueur maximale d'une URL est de 2 083 caractères, la requête est bloquée si la longueur dépasse cette limite.

Exemple

http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=62193,59094,45234&size=2&format=json&pretty

{ "count" : 7,
"first" : "http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=6...",
"last" : "http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=6...",
"prev" : null,
"next" : "http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=6...",
"data" : [ { "code_bss" : "00026X0040/P1", "urn_bss" : "http://services.ades.eaufrance.fr/pointeau/00026X0040/P1", "date_debut_mesure" : "1970-01-05", "date_fin_mesure" : "2007-05-15", "code_commune_insee" : "62193", "nom_commune" : "CALAIS", "x" : 1.913928133, "y" : 50.96529028, "codes_bdlisa" : [ "101AC01" ], "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ 1.913928133, 50.96529028 ] }, "urns_bdlisa" : [ "http://reseau.eaufrance.fr/geotraitements/bdlisa/files/entite/101AC01.pdf" ] },