Cette article décrit les principes généraux de l'API PYSAE.
Groupe
Les données sont regroupées par groupe. Un groupe est identifié par un "group_id".
Protocole d’échange - transport
Le protocole de transport utilisé est le HTTPS.
Lorsque le header Accept-Encoding : gzip est présent dans la requête, une compression de type gzip est appliquée pour optimiser les échanges.
Authentification
Pour accéder aux données statistiques, les requêtes sont authentifiées avec un token référençant un utilisateur ayant les droits d’accès lecture ou administration au groupe concerné.
Format
Le format utilisé est de type REST/JSON :
Les paramètres sont passés dans la query string de la requête http
Les réponses sont au format JSON, soit dans un tableau pour renvoyer une liste de résultats, soit un objet JSON lorsque la requête concerne un seul élément identifié
Définitions
De nombreux champs utilisés dans ces services utilisent les noms de champs du GTFS, se référer à la documentation : https://developers.google.com/transit/gtfs/reference/.
Les service PYSAE représentent souvent les instants en timestamp UNIX, à savoir le nombre de secondes depuis le 01/01/1970 00:00 UTC sans les secondes intercalaires.
Les avance-retard sont exprimées en secondes, une valeur négative représentant une avance et une valeur positive un retard (en général le champ « delay »).