Hydrobiologie

2023

• 12/09/2023 : déploiement de correctifs.

2022

• 19/07/2022 : mise à disposition de la v1 : ajout des paramètres code_prelevement et code_banque_reference.

2020

• 28/05/2020 : mise à disposition de la version beta.

Les formats supportés sont : JSON, GeoJSON et CSV.

L'API "Hydrobiologie" est accessible :

• en http : http://hubeau.brgm-rec.fr/api/v1/hydrobio/taxons?code_appel_taxon=10468&code_departement=62&pretty
• en https : https://hubeau.brgm-rec.fr/api/v1/hydrobio/taxons?code_appel_taxon=10468&code_departement=62&pretty

Pour gérer le cross-domain, l'API supporte les protocoles :

• CORS (Cross Origin Resource Sharing)
• JSONP avec le paramètre callback pour les anciens navigateurs : https://hubeau.brgm-rec.fr/api/v1/hydrobio/taxons?code_appel_taxon=10468&code_departement=62&pretty&callback=jquery12

Chaque page renvoie un nombre de résultats égal au paramètre size.

L'API Hydrobiologie utilise un type de pagination non séquentiel qui permet de sauter d'une page à l'autre de résultats dans n'importe quel ordre. En contre-partie, la profondeur d'accès aux résultats est limitée.

Paramètres

• page : le numéro de page
• size : la taille de la page

Attributs

• Les attributs prev et next (définis à null si il n'y a pas de page précédente et/ou suivante) sont disponibles dans l'URL de la réponse pour éviter d'avoir à calculer les pages précédentes et/ou suivantes
• L'attribut first permet d'accéder à la première page des résultats,
• L'attribut last permet d'accéder à la dernière page des résultats,
• L'attribut count permet de compter le nombre total de résultats,
• L'attribut data permet d'accéder aux résultats sous forme de liste.

Un tutoriel sur l'API Qualité des cours d'eau explique, dans la partie Taille des pages de réponse, la mise en oeuvre pratique de la pagination à l'aide d'un cas concret.
Enfin, des exemples de code en Python, R et php sont disponibles dans la partie Exemples de la page de contribution GitHub de Hub'Eau.

Pagination

• Taille de page : 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 valeur est indiquée dans les commentaires de l'opération. Par exemple : "taille de page par défaut : 2000, taille max de la page : 10000."
• Profondeur d'accès aux résultats : la profondeur d'accès aux résultats (numéro de la page * nombre maximum de résultats dans une page) est limitée à 10 000 enregistrements.

Taille de l'URL

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

L'API "Hydrobiologie" propose actuellement 3 opérations :

• stations_hydrobio (opération : Lister les stations avec prélèvements hydrobiologiques) - permet de récupérer toutes les stations où des prélèvements hydrobiologiques ont eu lieu.
• indices (opération : Lister les indices biologiques) - permet de récupérer les indices (ou résultats) biologiques.
• taxons (opération : Lister les appelations de taxons) - permet de récupérer les listes floristiques ou faunistiques.

Recherche de toutes les stations hydrobiologiques du Loiret :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/stations_hydrobio?code_departement=45

Recherche de toutes les stations en service au 1er janvier 2018 où a été identifié le taxon Rhabdiopteryx (code SANDRE de cette appellation de taxon = 10) :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/stations_hydrobio?codes_appel_taxons=10&size=10&date_service=2018-01-01

Recherche des indices biologiques par rayon autour d'un point (10 km de distance autour du point de latitude 45° et de longitude 6°) :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/indices?distance=10&format=json&latitude=45&longitude=6&size=20

Recherche de tous les indices biologiques concernant les diatomées (dont le code SANDRE support = 10) :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/indices?size=10&code_support=10

Recherche de tous les Indices Biologiques Diatomées (IBD, code SANDRE=5856) dont la valeur est comprise entre 12 et 13 :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/indices?code_indice=5856&format=json&resultat_indice_min=12&resultat_indice_max=13&size=50

Recherche de tous les indices IBMR :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/indices?libelle_indice=IBMR

Limitation aux résultats dont la qualification est correcte :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/indices?libelle_indice=IBMR&code_qualification=1

Recherche de tous les résultats d'indices biologiques concernant la station 03000070 :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/indices?code_station_hydrobio=03000070

Limitation des résultats à quelques champs (paramètre fields) :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/indices?code_station_hydrobio=03000070&fields=code_indice,libelle_indice,date_prelevement,resultat_indice

Recherche de tous les taxons identifiés lors de l'année 2015 :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/taxons?date_debut_prelevement=2015-01-01&date_fin_prelevement=2016-01-01

Recherche de tous les taxons Anguille (code SANDRE appellation de taxon = 2038) :
https://hubeau.brgm-rec.fr/api/v1/hydrobio/taxons?code_appel_taxon=2038