Ce document décrit l’interface GTFS-RT (ou GTFS-realtime) sur PYSAE.
Point d'accès
Le connecteur GTFS-RT pour votre groupe est accessible à l'adresse suivante (comprend tous les services):
https://pysae.com/api/v2/groups/[group_id]/gtfs-rt
group_id est l'identifiant de votre groupe dans PYSAE.
Nous proposons des alias, en cas de nécessité d'une adresse par service :
https://pysae.com/api/v2/groups/[group_id]/gtfs-rt/trip-update
https://pysae.com/api/v2/groups/[group_id]/gtfs-rt/vehicle-position
https://pysae.com/api/v2/groups/[group_id]/gtfs-rt/alert
Voici un exemple de flux en fonctionnement :
Attention, le résultat d'une requête gtfs-rt est un fichier binaire. Il n'est donc pas lisible directement par un éditeur de texte.
Protocole d’échange
Transport
Le protocole de transport utilisé est le HTTPS.
Format
Conformément à la norme GTFS-RT les données sont renvoyée sous forme de ProtocolBuffer dont la description et les fichiers .proto se trouvent ici :
https://developers.google.com/transit/gtfs-realtime/reference/.
Services proposés
Les services proposés sont les suivants :
TripUpdate
VehiclePosition
Alert
Service TripUpdate
Le tableau qui suit détaille le contenu du service TripUpdate.
Intitulé | Type | Disponibilité PYSAE | Commentaire |
trip | TripDescriptor | Oui | Course concernée |
vehicle | VehicleDescriptor | Oui | Véhicule concerné |
stop_time_update | StopTimeUpdate | Oui | Mise à jour du temps de passage |
VehiclePosition
Le tableau qui suit détaille le contenu du service VehiclePosition.
Intitulé | Type | Disponibilité PYSAE | Commentaire |
trip | TripDescriptor | Oui | Course concernée |
vehicle | VehicleDescriptor | Oui | Véhicule concerné |
position | Position | Oui | Position du véhicule |
current_status | VehicleStopStatus | Oui | Status du véhicule par rapport au prochain arrêt |
congestion_level | CongestionLevel | Non | Difficultés de circulation |
_occupancy_status_ | OccupancyStatus | Non | Taux d’occupation |
Alert
Le tableau qui suit détaille le contenu du service Alert.
Intitulé | Type | Disponibilité PYSAE | Commentaire |
active_period | TimeRange | Oui | Période d’application |
informed_entity | EntitySelector | Oui | Élément concerné (course, arrêt, ligne) |
header_text | TranslatedString | Oui | En-tête de l'alerte |
description_text | TranslatedString | Oui | Description de l'alerte |
cause | Cause | Oui | Cause de la perturbation |
effect | Effect | Oui | Effet de la perturbation |
url | TranslatedString | Non | Traduction du message |