{% extends "base.html" %} {% block title %}API{% endblock %} {% block content %}
L'API de cada.data.gouv.fr ne contient que deux points d'entrée:
/api/<id>/
: pour l'accès direct à un avis depuis son identifiant/api/search/
: pour la recherche paginéeLe fonctionnement est strictement similaire à celui des pages web.
Cette API permet l'accès direct à un avis CADA par son identifiant
Voici un exemple d'accès direct à l'avis CADA n°20134525
GET {{ url_for('api_display', id='20134525') }}
La recherche accepte les paramètres d'URL suivants:
q
: recherche textuellesort
: critère de tri. Le tri s'effectue sur le score de recherche si ce paramètre n'est pas spécifié. Les valeurs possibles sont:
administration (asc|desc)
: tri par administrationstopic (asc|desc)
: tri par thémessession (asc|desc)
: tri par date de séanceadministration
: filtre sur l'administration spécifiéetag
: filtre sur la tag spécifié (peut-être spécifié plusieurs fois)topic
: filtre sur le thème spécifiésession
: filtre sur la session spécifiée (au format yyyy-mm-dd
part
: filtre sur le partie pris (au choix, 1, 2 ou 3)meaning
: filtre sur les réponses donnéespage
: affiche la page indiquée (en relation avec page_size
page_size
: spécifie la taille de la pagination (20 par défaut)La réponse est un objet JSON à 5 attributs:
advices
: une liste triée des avis correspondants aux critères de recherchepage
: le numéro de la page courantepage_size
: la taille de la paginationtotal
: le nombre total d'avis retournés par la recherchefacets
: Les différents facettes associées à la recherche sous la forme de liste de triplets:
true
si un filtre est appliqué sur cette valeurVoici un exemple de recherche sur le terme "Paris", triée par dates de séance décroissantes et n'affichant que les 3 premiers éléments
GET {{ url_for('api_search', q='Paris', sort='session desc', page_size=3) }}