Documentation de l'api

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

Commande "getFluiditeAxesRoutiers" ^nouveau
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

Fonctionnement de l'API

URL d'accès à l'APIFonctionnement de l'API

Il est possible d'attaquer l'API sur l'URL suivante :

 http://data.nantes.fr/api/

Cette URL accepte les requêtes via les méthodes POST ou GET.

Formats de sortie XML ou JSONFonctionnement de l'API

Le format de sortie par défaut est XML mais il est également possible d'attaquer l'API dans sa version JSON en ajoutant un paramètre à l'URL :

 output=json

Les exemples de la documentation seront tous donnés en XML, mais sont aussi valables pour le JSON au format de sortie prêt

Paramètres d'appels obligatoires

Fonctionnement de l'API

Paramètres	Valeur
cmd	La commande à exécuter.
version	Actuellement 1.0 seulement.
key	Votre clé d'API.

Voici un exemple d'appel de l'API à l'aide la méthode GET.

http://data.nantes.fr/api/<cmd>/<version>/<key>

Format de réponse de l'API

Fonctionnement de l'API

L'API fournit des réponses au format XML. La réponse contient systématiquement les éléments suivant :

Tag	Description
<request>	Un écho de la commande complète envoyé à l'API. Permet de vérifier que la commande reçue par l'API est bien celle envoyée.
<answer>	Les données de réponse de l'API.
<status>	Le statut de la réponse de l'API. La signification des codes est disponible ici.
<data>	Les données proprement dites. Leurs formats est spécifique à chaque commande.

Voici un exemple de réponse de l'API.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<opendata>
        <request>data.nantes.fr/api/getInfoTraficTANTempsReel/1.0/XXXXXXXXXXXXXXX</request>
        <answer>
                <status code="1" message="The provided API key is invalid. Please check it."/>
        </answer>
</opendata>

Code de statut de la commande

Fonctionnement de l'API

Code	Signification	Description
0	Success	La commande c'est déroulée avec succès
1	Invalid key	La clé est invalide
2	Invalid version	La version est invalide
3	Invalid command	La commande est invalide
4	Empty key	La clé est vide
5	Empty version	La version est vide
6	Empty command	La commande est vide
8	Usage limit reached	Le nombre de requêtes de la clé a été atteint
98	Disabled	L'API a été désactivée par un administrateur
99	Maintenance	L'API est en cours de maintenance.
100+	Command error code	Le code d'erreur est spécifique à la commande