API Poisson

Les données de l'API "Poisson" (état piscicole) sont issues de la base IMAGE (Information sur les Milieux Aquatiques pour la Gestion Environnementale), administrée par l'AFB (anciennement ONEMA). 

Collectées annuellement par pêche scientifique à l’électricité, ces données permettent d’établir un état précis des espèces de poissons présentes dans les rivières françaises et de leur densité.

Elles portent sur :

• les tailles des poissons par opération, sur une station donnée, observée à partir de pêches électriques (voir les métadonnées)
• les nombre des poissons par espèce et par opération, sur une station donnée, observée à partir de pêches électriques (voir les métadonnées)

La base IMAGE n'est plus alimentée depuis 2013.

 

Console de l'API Spécification Swagger

 

Faites-nous part de vos commentaires sur le forum de contribution Github

 

• Derniers changements
• Exposition des données
• Accessibilité
• Pagination
• Limitations
• Opérations
• Exemple

 

Derniers changements

2019

03/01/2019 : v0.3.1

• Correction bug sur le paramètre code_espece_poisson de l'API poissons, le filtrage par code_espece_poisson fonctionne de nouveau

2018

22/05/2018 : v0.3.0

• ajout d'une limitation sur la profondeur d'accès aux résultats, le calcul de la profondeur = numéro de la page * nombre maximum de résultats dans une page
• ajout du header "link" pour le format CSV
• correction code retour pour le format CSV, gère le code 200 et 206

2017

29/11/2017 : ajout de dans la réponse de l'attribut api_version (string) : version de l'API (https://semver.org/)
04/05/2017 : mise à jour de l'adresse de l'API api.hubeau.fr vers hubeau.eaufrance.fr/api/

2016

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

 

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.

 

Accessibilité

L'API "Poisson" est accessible :

• en http : http://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece_poisson=ABL&size=5&pretty
• en https : https://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece_poisson=ABL&size=5&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 : http://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece_poisson=ABL&callback=jquery12&size=5&pretty

 

Pagination

Les méthodes suivent toutes le même modèle de pagination :

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.

 

Limitations

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 : 5000, taille max de la page : 20000."

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 à 20 000 enregistrements. Cette limite peut empêcher la récupération de l'intégralité des résultats d'une requête ; il faut alors découper la requête en plusieurs requêtes à l'aide de critères plus discriminants.

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.

 

Opérations (endpoints)

L'API "Poisson" propose différentes opérations :

• l'opération code_espece_poisson permet d'obtenir : 
  • les correspondances des codes des espèces de poissons entre le référentiel AFB (3 lettres) et le référentiel SANDRE (code numérique)
  • les noms commun et latin des espèces à partir des codes AFB ou SANDRE
• l'opération lieux_peche permet d'obtenir les stations et cours d'eau où ont été effectuées des pêches électriques :
  •  à partir d'une ou plusieurs espèces de poissons, 
  • et / ou dans une emprise géographique définie (département, commune, sous-secteur hydrographique)
  • et / ou durant une période d'opération
• l'opération poissons permet d'obtenir les résultats des inventaires réalisés dans les rivières françaises par pêche scientifique à l’électricité :
  • informations sur les stations (localisation, cours d'eau)
  • informations sur les opérations de pêche scientifique à l’électricité (date, espèces de poissons pêchées, effectifs de chaque espèce, classes de taille de chaque espèce)
  • par code station et / ou sur une période de temps définie

 

 

Console de l'API