Documentation

Cette page décrit l'ensemble des services web permettant d'accéder aux données sur les indicateurs des services d'eau et d'assainissement.

Origine des données

Ces données proviennent du site http://www.services.eaufrance.fr ; elles portent sur les indicateurs réglementaires sur les services publics d'eau, d'assainissement, et sur l'assainissement non collectif.

Les métadonnées sont disponibles à :

- http://www.data.eaufrance.fr/jdd/ef98692d-3be2-444e-8fe7-9d5760b5ac2c

- http://www.data.eaufrance.fr/jdd/e37c1716-1cb7-4a2d-877a-2b15ad06c1cc

- http://www.data.eaufrance.fr/jdd/a8d7a630-b33d-4c0b-a865-ecbe20360de5

Les données sont mises à jour au fil des remontées de données par les collectivités locales sur le site service, et tous les mois (le 1er du mois) sur 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 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/
    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/indicateurs_services/services?code_commune=17300&size=3&pretty

https://hubeau.eaufrance.fr/api/v0/indicateurs_services/services?code_commune=17300&size=3&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/v0/indicateurs_services/services?code_commune=17300&size=3&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/indicateurs_services/services?code_commune=17300&size=3&pretty

{ "count" : 24,
"first" : "http://hubeau.eaufrance.fr/api/v0/indicateurs_services/services?code_com...",
"last" : "http://hubeau.eaufrance.fr/api/v0/indicateurs_services/services?code_com...",
"prev" : null,
"next" : "http://hubeau.eaufrance.fr/api/v0/indicateurs_services/services?code_com...",
"data" : [ { "code_service" : 199694, "nom_service" : "assainissement non collectif", "codes_commune" : [ "17010", "17028", "17059", "17094", "17109", "17136", "17142", "17153", "17190", "17193", "17194", "17200", "17222", "17245", "17264", "17274", "17291", "17300", "17315", "17373", "17391", "17407", "17413", "17414", "17420", "17443", "17466", "17483" ], "noms_commune" : [ "Angoulins", "Aytré", "Bourgneuf", "Châtelaillon-Plage", "Clavette", "Croix-Chapeau", "Dompierre-sur-Mer", "Esnandes", "L' Houmeau", "La Jarne", "La Jarrie", "Lagord", "Marsilly", "Montroy", "Nieul-sur-Mer", "Périgny", "Puilboreau", "La Rochelle", "Saint-Christophe", "Saint-Médard-d'Aunis", "Saint-Rogatien", "Sainte-Soulle", "Saint-Vivien", "Saint-Xandre", "Salles-sur-Mer", "Thairé", "Vérines", "Yves" ], "numero_siren" : "241700434", "type_collectivite" : "Communauté d'agglomération", "mode_gestion" : "régie", "annee" : 2015, "indicateurs" : { "D301.0" : 2800.0, "P301.3" : 78.0395852969, "DC.196" : 110.1, "DC.197" : null, "VP.167" : 1061.0, "VP.166" : 828.0, "VP.168" : 1.0, "VP.169" : 1.0, "VP.230" : 100.0 } },