API anne-hidalgo.net

L’API du site anne-hidalgo.net vous permet d'accéder à une partie des contenus publiés sur le site pour développer des services et des applications autour de la campagne.

Elle sera mise à jour et enrichie tout au long de la campagne.

Informations générales

Clés d’API

La fréquence et le nombre de ressources disponibles sont limités si vous ne disposez pas d'une clé d'API (ou API key). Pour en obtenir une il suffit de faire une demande auprès de notre équipe technique. N'oubliez pas de nous donner un rapide descriptif de votre idée pour que nous puissions vous orienter au mieux dans les outils disponibles.

Structure des URLs

L’url de base de l’API est :

http://www.anne-hidalgo.net/api/

La structure des URLs est conçue de la manière suivante :

http://www.anne-hidalgo.net/api/[version]/[ressource].[format]

Par exemple :

http://www.anne-hidalgo.net/api/1/articles.json

Pour chaque ressource, vous pouvez préciser un certain nombre de paramètres pour filtrer les résultats. Par exemple, si vous souhaitez une liste des derniers articles de la catégorie "actualité" avec des images de "grand" format :

http://www.anne-hidalgo.net/api/1/articles.json?format=grand&categorie=actualite

Erreurs

Liste des champs

Clé Valeur
status Code de statut HTTP.
developerMessage Le contenu de ce champs vous donne une explication "technique" de l'erreur qui s'est produite, elle ne sera probablement d'aucune aide à vos utilisateurs.
userMessage Message "grand public" que vous pouvez afficher aux utilisateurs de votre application.
errorCode Code unique de l'erreur.
moreInfo Une ou plusieurs URLs, séparées par des virgules, pour vous permettre de mieux comprendre le problème.

Ressources

Les articles

GET articles.json

Renvoie une liste des derniers articles

Paramètres
arrondissement

Permet de filtrer les résultats par arrondissement. Celui-ci doit être indiqué par son numéro, en chiffre uniquement.

Liste des valeurs possibles : 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20

categorie

Permet de filtrer les résultats par catégorie.

Valeurs possibles : actualite, communique, terrain, presse, presse_etrangere

format

Format des images

Valeurs acceptées :

  • petit : 100x100px
  • moyen : 220x220px
  • grand : 480x480px
geolocalise

Permet de filtrer les résultats pour ne retenir que les articles géolocalisés.

Valeurs possibles : 1

api_key

Pour indiquer votre clé d'API (ou API Key)

Réponse
id Identifiant unique de l'article sur le site.
titre Titre de l'article.
shortUrl URL "courte" d'accès à l'article.
url URL complète de l'article.
timestamp Date de publication au format timestamp UNIX.
arrondissement Si l'article est rattaché à un arrondissement, son nom complet (e.g. "9e arrondissement").
arrondissementNumero Si l'article est rattaché à un arrondissement, son numéro (e.g. "9").
latitude Latitude de l'article, si celui-ci est géolocalisé.
longitude Longitude de l'article, si celui-ci est géolocalisé.
image Url de l'image d'illustration de l'article (si elle existe), au format spécifié en paramètre (par défaut : 'moyen')