Raccourcis:

URL d'accès à l'API

Il est possible d'attaquer l'API dans sa version XML sur l'URL suivante : 

 http://www.data.rennes-metropole.fr/xml/

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

URL d'accès à l'API en JSON

Il est également possible d'attaquer l'API dans sa version JSON sur l'URL suivante : 

http://www.data.rennes-metropole.fr/json/

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

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

Paramètres d'appels obligatoires

Paramètres

Valeur

version

Actuellement 1.0 seulement.

key

Votre clé d'API.

cmd

La commande à executer.

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

http://www.data.rennes-metropole.fr/xml/?version=1.0&key=XXXXXXXXXXXXXXX&cmd=macommande

Format de réponse de l'API

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

Tags

descriptions

<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.


<opendata>
    <request>http://www.data.rennes-metropole.fr/xml/</request>
    <answer>
        <status code="4" message="Please, provide an API key."/>

    </answer>
</opendata>

Code de statut de la commande

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