En poursuivant votre navigation sur ce site, vous acceptez l'utilisation de cookies permettant d'améliorer votre expérience utilisateur.
En savoir plus et gérer ces paramètres x
accéder au contenu principal de la page

Documentation de l'API

Documentation de l'API
Retrouvez en détails la documentation précisant le fonctionnement de l'API version 2 de data.nantes.fr

Commande "getDisponibiliteParkingsPublics"
Cette commande permet de récupérer les informations concernant la disponibilité des parkings publics de l'agglomération nantaise.

Commande "getFluiditeAxesRoutiers"
Cette commande retourne les indicateurs de fluidité du trafic sur les tronçons routiers.

Commande "getInfoTraficTANPrevisionnel"
Cette commande permet de récupérer l'info trafic prévisionnel des bus et tramway de la SEMITAN.

Commande "getInfoTraficTANTempsReel"
Cette commande permet de récupérer l'info trafic en temps réel des bus et tramway de la SEMITAN

Commande "getTempsParcours"
Indication des temps de parcours en minutes sur chaque itinéraire.

Commandes "datastore"
Cet ensemble de commandes regroupe les fonctionnalités d'interrogation du catalogue de données.
   • datastore_searchdatasets
   • datastore_getdatasets
   • datastore_getagencies
   • datastore_getfileformats
   • datastore_getlicences

datastore_searchdatasets

Présentationdatastore_searchdatasets

Cette commande permet de rechercher des jeux de données sur l'entrepôt de données du site "Open Data" de la Ville de Nantes et de Nantes Métropole (ou NOD). Elle réalise l'équivalent de la page data.nantes.fr/donnees/ mais d'un point de vue logiciel plutôt qu'utilisateur.

Cette commande ne retourne que les identifiants des jeux qui satisfont aux critères de recherche mentionnés en paramètre. Pour avoir le détail du jeu de données, il est nécessaire d'utiliser par la suite la commande datastore_getdatasets.

URL d'appeldatastore_searchdatasets

Voici l'url d'appel de la commande :

http://data.nantes.fr/api/datastore_searchdatasets/1.0/XXXXXXXXXXXXXXX

Paramètres d'entréedatastore_searchdatasets

 

Paramètre

Description

Type

Obligatoire

Exemple

agencies

Liste d'id pour filtrer par gestionnaire (séparateur ',')

String

Non

7 (pour "Air Pays de la Loire")

fileformats

Liste d'id ou de nom de format (séparateur ',')

String

Non

XML,CSV

licences

Liste d'id pour filtrer par licence

String

Non

2 (pour "ODbL")

released

Permet de récupérer les jeux par date de mise à disposition (format aaaa-mm-dd)

String

Non

2011-11-15

updated

Permet de récupérer les jeux par date de mise à jour (format aaaa-mm-dd)

String

Non

2011-12-06

limit

Nombre de résultat par page. Si non précisé, une seule page sans limite

Number

Non

10

page

Numéro de page à consulter. La première page commence à '1'

Number

Non

2

 

Exemples d'appeldatastore_searchdatasets

Ces exemples sont basés sur une clé de démonstration qu'il ne convient pas de réutiliser autrement qu'à but de prise de connaissance du fonctionnement de l'API ou à but de tests.

Pour une utilisation réelle des API offertes par le site Open Data de Nantes Métropole, merci d'ouvrir un compte utilisateur et d'enregistrer votre application. Une clé d'API personnelle vous sera alors attribuée.

Exemple d'appel pour un retour XML :

data.nantes.fr/api/datastore_searchdatasets/1.0/39W9VSNCSASEOGV

Exemple d'appel pour un retour JSON :

data.nantes.fr/api/datastore_searchdatasets/1.0/39W9VSNCSASEOGV/

Exemple d'appel recherchant tous les jeux disponibles dans l'entrepôt aux formats GTFS ou JPG en limitant le nombre de résultat à 2 par page :

data.nantes.fr/api/datastore_searchdatasets/1.0/39W9VSNCSASEOGV

Exemple d'appel recherchant tous les jeux de l'entrepôt qui ont été mis à jour entre le 1 décembre 2011 et aujourd'hui :

data.nantes.fr/api/datastore_searchdatasets/1.0/39W9VSNCSASEOGV

Résultat en sortiedatastore_searchdatasets

Exemple de flux XML en sortie :

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<opendata>
 
<request>data.nantes.fr/api/datastore_searchdatasets/1.0/39W9VSNCSASEOGV</request>
 
<answer>
   
<status code="0" message="OK"/>
   
<data items="3" pages="2" limit="2">
     
<dataset>
       
<id>21</id>
     
</dataset>
     
<dataset>
       
<id>40</id>
     
</dataset>
   
</data>
 
</answer>
</opendata>

 

Voici la description des éléments de ce flux XML :

Elément

Description

Exemple

dataset

1 noeud pour chaque jeu de données

 

id

identifiant du jeu de données qui satisfait les critères de recherche

21