Documentation

Cette page décrit l'ensemble des services web permettant d'accéder aux données sur la qualité des rivières.

Origine des données

Ces données sont issues des banques de bassin des agences de l'eau Adour Garonne et Loire Bretagne. A terme l'ensemble des données des bassins sera disponible, en provenance de naiades.eaufrance.fr

Ces données ne sont pas mises à jour actuellement.

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 page suivante : Informations générales sur l'API.
Pour vos questions et remarques http://hubeau.eaufrance.fr/forum

Derniers changements

04/05/2017 : mise à jour de l'adresse de l'API api.hubeau.fr vers hubeau.eaufrance.fr/api/
25/10/2016 : ajout des données qualité des rivières de l'agence de l'eau Loire Bretagne
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/v0/qualite_rivieres/lieux_mesure?code_commune=17300,17299&pretty

https://hubeau.eaufrance.fr/api/v0/qualite_rivieres/lieux_mesure?code_commune=17300,17299&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 :

https://hubeau.eaufrance.fr/api/v0/qualite_rivieres/lieux_mesure?code_commune=17300,17299&pretty&callback=jquery12

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.


Exemple :

http://hubeau.eaufrance.fr/api/v0/qualite_rivieres/lieux_mesure?code_commune=17300,17299&size=3&pretty

{ "count" : 11,
"first" : "http://hubeau.eaufrance.fr/api/v0/qualite_rivieres/lieux_mesure?code_com...",
"last" : "http://hubeau.eaufrance.fr/api/v0/qualite_rivieres/lieux_mesure?code_com...",
"prev" : null,
"next" : "http://hubeau.eaufrance.fr/api/v0/qualite_rivieres/lieux_mesure?code_com...",
"data" : [ { "id_lieu_mesure" : "04782000001", "code_station" : "04782000", "libelle_site" : "CANAL DE MARANS LA ROCHELLE À LA ROCHELLE", "libelle_usuel_site" : "CANAL DE MARANS LA ROCHELLE À LA ROCHELLE", "date_debut" : "2011-02-21", "date_fin" : "2011-12-15", "codes_commune_insee" : [ "17300" ], "reseaux_mesure" : [ "0500000117" ], "nom_station" : "CANAL DE MARANS LA ROCHELLE À LA ROCHELLE", "location_precise" : "AMONT ECLUSE VIEUX PORT", "x_station" : -1.147241678, "y_station" : 46.158788106, "code_troncon_hydrographique" : null, "code_entite_hydrographique" : "N8--300G", "code_point_eaux_surface" : "001", "x_point_eaux_surface" : -1.147244266, "y_point_eaux_surface" : 46.158788012, "commentaire_point_eaux_surface" : "3;AMONT ECLUSE VIEUX PORT", "codes_parametre" : [ ], "noms_parametre" : [ ], "uris_parametre" : [ ], "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ -1.147244266, 46.158788012 ] } }