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_getdatasets

Présentationdatastore_getdatasets

Cette commande permet de récupérer le détail d'un ou de plusieurs 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). Il est ainsi possible (entre autre) de récupérer les urls de télécharchement des fichiers de données dans les différents formats proposés.

URL d'appeldatastore_getdatasets

Voici l'url d'appel de la commande :

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

Paramètres d'entréedatastore_getdatasets

 

Paramètre

Description

Type

Obligatoire

Exemple

ids

Liste d'identifiants de jeu de données

String

Oui

23,24

 

Exemples d'appeldatastore_getdatasets

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 du détail du jeu des "Adresses postales de Nantes Métropole" :

http://data.nantes.fr/api/datastore_getdatasets/1.0/39W9VSNCSASEOGV?param[ids]=792

Exemple d'appel pour un retour JSON :

http://data.nantes.fr/api/datastore_getdatasets/1.0/39W9VSNCSASEOGV/?output=json&param[ids]=792

Résultat en sortiedatastore_getdatasets

Exemple de flux XML en sortie :

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<opendata>
 
<request>data.nantes.fr/api/datastore_getdatasets/1.0/39W9VSNCSASEOGV</request>
 
<answer>
   
<status code="0" message="OK"/>
   
<data>
     
<dataset>
       
<id>20</id>
       
<title>Occupation du sol 2008 de niveau 3</title>
       
<released>2011-11-17T00:00:00+01:00</released>
       
<updated>1970-01-01T01:00:00+01:00</updated>
       
<files>
         
<file>
           
<type>data</type>
           
<url>data.nantes.fr/fileadmin/data/datastore/3-publication/urbanisme/ocs_2008/occupation_sol_2008_wgs84_kml.zip</url>
           
<format>KMZ</format>
           
<md5></md5>
           
<size></size>
         
</file>
         
<file>
           
<type>data</type>
           
<url>data.nantes.fr/fileadmin/data/datastore/3-publication/urbanisme/ocs_2008/occupation_sol_2008_cc47_shp.zip</url>
           
<format>SHP (CC47)</format>
           
<md5></md5>
           
<size></size>
         
</file>
         
<file>
           
<type>data</type>
           
<url>data.nantes.fr/fileadmin/data/datastore/3-publication/urbanisme/ocs_2008/occupation_sol_2008_l93_shp.zip</url>
           
<format>SHP (L93)</format>
           
<md5></md5>
           
<size></size>
         
</file>
       
</files>
     
</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

20

title

Nom du jeu de données

Occupation du sol 2008 de niveau 3

released

Date de mise à disposition du jeu

2011-11-17T00:00:00+01:00

updated

Date de mise à jour du jeu (= "1 janv. 1970" si encore jamais mis à jour)

1970-01-01T01:00:00+01:00

files

Noeud accueillant les fichiers dans leurs différents formats de mise à disposition

 

file

1 noeud pour chaque format de fichier

 

type

Type : 1 seule valeur pour le moment = 'data'

data

url

Url complète permettant la récupération du fichier de données

data.nantes.fr/.../..._wgs84_kml.zip

format

Format du fichier

KMZ

md5

Non disponible pour le moment

 

size

Non disponible pour le moment