Comment utiliser le module starapi¶

Introduction¶

Après avoir installé le module starapi vous avez besoin de deux choses :

• Une clé d’API fournie par Keolis,
• Faire un import du module starapi et d’utiliser les classes dont vous avez besoin.

Le module propose deux façons de faire : en utilisant les fonctions de haut niveau du module, ou en utilisant directement les fonctions et classes de bas niveau.

Ainsi, en fonction de la granularité d’action dont vous avez besoin, vous êtes libres d’utiliser directement les couches les plus basses du module.

C’est très pratique si vous voulez simplement faire quelques appels, ou construire tout un mécanisme de cache devant les appels.

Client haut-niveau¶

Il existe deux clients haut-niveau :

• Le réseau de vélo du Star : starapi.LeveloStar.
• Le réseau de bus et de métro du Star : starapi.NetworkStar.

Vous pouvez simplement obtenir un client pour ces API avec les fonctions starapi.levelostar() et starapi.networkstar() en fournissant votre clé d’API en paramètre.

Vous obtiendrez alors un client prêt à l’emploi.

>>> import starapi
>>> client = starapi.levelostar('YOUR_KEOLIS_KEY_HERE')
>>> districts = client.get_districts()
>>> for district in districts:
...     print('[%s] %s' % (district.get('id'), district.get('name')))
...
[34] Sud-Gare
[35] Francisco Ferrer-Vern-Poterie
[36] Jeanne d'Arc-Longs Champs-Atalante
[37] Bréquigny
[38] Le Blosne
[39] Villejean-Beauregard
[40] St Martin
[41] Maurepas - Patton
[42] Bourg l'Evêque-La Touche-Moulin du Comte
[43] Thabor - St Hélier
[44] Cleunay-Arsenal-Redon
[45] Centre-Ville

Les handlers : bas niveau¶

Muni de vôtre clé d’API, vous pouvez instancier un Handler qui formatera les requêtes pour vous.

Lorsque vous appelez une fonction du Handler, les paramètres sont vérifiés, puis une url est construite avec les paramètres formatés comme il faut. Enfin, un appel HTTP est effectué, et le résultat est directement retourné comme réponse à l’appel de la fonction.

Comme le module requests est utilisé, c’est donc un objet Response de ce même module qui est retourné à chaque appel.

>>> r = api.getlines()
>>> root = root.fromstring(r.text.encode('utf-8'))
>>> root.xpath('/opendata/answer/status')
[<Element status at 0x1ed2eb0>]
>>> status = root.xpath('/opendata/answer/status')[0]
>>> status.get('code')
'0'
>>> status.get('message')
'OK'

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<opendata>
    <request><!-- REQUEST URL --></request>
    <answer>
        <status code="0" message="OK"/>
        <data>
            <!-- DATA RESPONSE -->
        </data>
    </answer>
</opendata>