Vous êtes ici : API Keolis Rennes / Les données / Fonctionnement de l'API

Fonctionnement de l'API

URL d'accès à l'API

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

 http://data.keolis-rennes.com/xml/

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

Accès en JSON

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://data.keolis-rennes.com/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	1.0 et 2.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://data.keolis-rennes.com/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://data.keolis-rennes.com/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

Passage des paramêtres

Chaque commande peut accepter un certains nombre de paramêtres. Les paramêtres doivent être passés dans un tableau nommé "param" selon la notation habituelle de PHP pour les URLs. Voici un exemple pour la commande getstation :


http://data.keolis-rennes.com/xml/?version=1.0&key=xxxxxxxxxxxxxxxx&cmd=getstation&param[request]=number&param[value]=5

La commande possède un paramêtre "request" qui vaut ici "number", ce qui signifie que l'on recherche une station par son numéro. Le numéro de la station est donc passé ensuite dans le paramêtre "value". Cette commande retourne donc les informations sur la station 5, c'est à dire :

<opendata>
    <request>http://data.keolis-rennes.com/xml/?version=1.0&amp;key=xxx&amp;cmd=getstation&amp;param[request]=number&amp;param[value]=5</request>
    <answer>
        <status code="0" message="OK"/>
        <data>
            <station>
                <id>5</id>
                <number>5</number>
                <name>SAINTE ANNE</name>
                <state>1</state>
                <latitude>48.11442</latitude>
                <longitude>-1.680715</longitude>
                <slotsavailable>15</slotsavailable>
                <bikesavailable>9</bikesavailable>
                <pos>1</pos>
                <district>Centre-Ville</district>
                <lastupdate>2010-03-19T10:34:18+01:00</lastupdate>
            </station>
        </data>
    </answer>
</opendata>

API KR

Les données