Mairie de Paris

Vue d'ensemble

Accès à l 'API


L'API Paris Connect permet d'accéder en lecture aux données mises à disposition par Paris Numérique.
L'accès à ces données nécessite :

  • de disposer d’un compte Paris Connect
  • d’interroger le serveur https://api.paris.fr:3000
  • d'être en possession d'un token

Réponses


La réponse de l'API est au format JSON dont le schéma est le suivant :

  • status : l'état de la réponse, peut prendre la valeur "success" ou "error".
  • data : les données de la requête, retourne un objet en cas de succès ou "null" en cas d'erreur.
  • message : Le détail de l'erreur ou "null" en cas de succès.
Le schéma contient deux entrées supplémentaires en cas de succès :
  • requestTime : le temps de réponse de la requête
  • api-version : la version de l'API utilisée.
Exemple (erreur):
{ status: "error", data: null, message: "invalid api_id or secret_key" }
Exemple (succès) :
{status: "success",
data: [
{
name: "Crèche collective municipale de Cotte",
address: "7 rue de Cotte ",
zipCode: 75012
}
],
message: null,
requestTime: "0.31061",
api-version: "2.0"
}

Versions


L'API de Paris Numérique est vivante !
Elle peut donc évoluer à tout instant. Pour ne pas pénialiser les applications développées à un instant T, il est possible de spécifier la version de l'API en paramètre de l'url d'appel.
Exemple : http://api.lestudio.in:3000/data/2.0/equipements... ou http://api.lestudio.in:3000/data/2.1/equipements...
Par défaut, la dernière version de l'API est utilisée si celle n'est pas précisée dans l'url (http://api.lestudio.in:3000/data/equipements...)

Limitations


L'accès à l'API est disponible uniquement sous forme de requête identifiée. Les identifiants sont fournis lors de la création de votre compte sur http://api.paris.fr.
Afin d'assurer la meilleure qualité de service possible, le nombre de requête effectué par heures est par défaut limité à 1000. Il est possible d'étendre cette limitation sur simple demande en cliquant sur ce lien.

QueFaire

get_categories


Description

Retourne la liste des rubriques (brocante, concert, expositions, etc...)

Retour

le nom et l'identifiant de la catégorie.

Paramètres

-

Console


QueFaire

get_activities


Description

Récupère les dernières activites et événements par catégories.

Retour

Retourne les dernières activités et événements.

Paramètres

cid (String), un ou des idenfiants de catégorie (séparés par des virigule, ie. 20,22)

created (Timestamp), date d'ajout de l'événement / activité. Peut prendre les valeurs "0" (récupère l'ensemble des donnnées dans la limite "limit") ou un timestamp

offset (Int), numéro de la ligne à partir duquel récupérer les données.

limit (Int), le nombre d'élément que l'on veut récupérer

Console


QueFaire

search_activities


Description

Recherche les activites et événements en cours ou à venir par mot clef.

Retour

Retourne les activités et événements ayant "mot clef" dans l'intitulé.

Paramètres

cid (String), un ou des idenfiants de catégorie (séparés par des virigule, ie. 20,22, indiquer "0" pour récupérer effectuer une recherche sur toutes les catégories confondues)

keyword (String), un mot clef

offset (Int), numéro de la ligne à partir duquel récupérer les données.

limit (Int), le nombre d'élément que l'on veut récupérer

Console


QueFaire

get_geo_activities


Description

Recherche les activites et événements en fonction d'un point (lat,lon), d'un rayon et d'une liste de catégories.

Retour

Retourne les dernières activités et événements classées par distance (du plus proche ou plus éloigné).

Paramètres

cid (String), un ou des idenfiants de catégorie (séparés par des virigule, ie. 20,22)

created (Timestamp), date d'ajout de l'événement / activité. Peut prendre les valeurs "0" (récupère l'ensemble des donnnées dans la limite "limit") ou un timestamp

lat (Double), latitude d'un point (WGS 84 - ex. 48.856332)

lon (Double), longitude d'un point (WGS 84 - ex. 2.353453)

radius (Int), rayon de recherche maximum à partir du point spécifié par lat et lon, exprimé en mètre.

offset (Int), l'offset

limit (Int), le nombre d'élément que l'on veut récupérer

Console


QueFaire

get_activity


Description

Récupère toutes les informations sur un événement donné.

Retour

Retourne un objet contenant l'ensemble des informations sur un événement donné.

Paramètres

id (Int), l'identifiant de l'évenement

Console


Equipements

get_categories


Description

Retourne la liste des catégories (piscines, parcs et jardins, bibliothèques, etc...)

Retour

le nom et l'identifiant de la catégorie.

Paramètres

-

Console


Equipements

get_equipements


Description

Recupère l'ensemble des équipements d'une catégorie donnée.

Retour

le nom, l'adresse et le code postal d'un équipement.

Paramètres

cid (String), un ou des idenfiants de catégorie (séparés par des virigule, ie. 27,29)

offset (Int), l'offset

limit (Int), le nombre d'entrée retourné

Console


Equipements

get_geo_equipements


Description

Recupère l'ensemble des équipements d'une catégorie donnée classé par distance d'un point donné.

Retour

le nom, l'adresse ,le code postal et la distance d'un équipement.

Paramètres

cid (String), un ou des idenfiants de catégorie (séparés par des virigule, ie. 27,29)

offset (Int), l'offset

limit (Int), le nombre d'entrée retourné

lat (Double), latitude d'un point (WGS 84 - ex. 48.856332)

lon (Double), longitude d'un point (WGS 84 - ex. 2.353453)

Console


Equipements

get_equipement


Description

Recupère les informations sur un équipements donnée

Retour

l'ensemble des informations sur un équipement notamment ses heures d'ouverture / fermeture sur les 28 prochains jours (mise à jour en continue).

Paramètres

id (Int), l'identifiant de l'équipement

Console


Equipements

get_crowd_level


Description

Retourne l'affluence d'un équipement.

Retour

crowd_level, un indicateur d'affluence allant de 1 à 3 (3 = bondé).
Si aucune information n'est disponible, crowd_level prend la valeur "-1"
Note : l'affluence concerne uniquement les équipements de type "Piscines". Elle est signalée par les utilisateurs de l'application IOs "Piscines" et n'est donnée qu'à titre d'information.

Paramètres

id (Int), l'identifiant de l'équipement

Console