Cet article décrit l'API qui permet d'accéder aux informations temps réel.

Horaires de passage prévus aux arrêts

URL : https://pysae.com/api/v2/groups/<group_id>/stop_times[?stop_id=<stop_id>]

Variables :

<groupe_id> : identifiant du groupe
<stop_id> : identifiant de l’arrêt

Résultat : Renvoie les heures de passage prévues à l’arrêt pour la journée avec éventuellement les heures de passage recalculées en temps réel lorsque des véhicules circulent. Réponse en json avec les champs suivants :

champ	Description	Statut
route_id, trip_id, trip_headsign, shape_id, stop_sequence, stop_id	Champs correspondant du GTFS (trips ou stop_times)
departure_time	Horaire de départ théorique en seconde après minuit le jour du départ
departure_ts	Timestamp UNIX de l’heure de départ théorique
device_id	Identifiant de l'appareil dans PYSAE
estimated_departure_ts	Optionnel, si un véhicule est connecté sur la course, horaire de départ prévu en timestamp UNIX actualisé en temps réel
eta	Optionnel, si un véhicule est connecté sur la course, horaire de départ prévu en secondes après minuit le jour du départ actualisé en temps réel
trip_schedule_relationship	Optionnel Vaut "CANCELED" si la course a été annulée	Version Bêta
trip_delay	Optionnel Vaut une valeur en minute indiquant le retard définit par l'exploitation	Version Bêta

Exemple de requête : https://pysae.com/api/v2/groups/pysae/stop_times

Exemple de réponse :

{
trip_id: "C1_6",
stop_id: "Stop_6",
departure_time: 42300,
departure_ts: 1592905500,
stop_sequence: 5,
route_id: "2",
trip_headsign: "Vers Sainte Marie",
shape_id: "TR_1",
device_id: "1ee22c15545115fe",
estimated_departure_ts: 1592905560,
eta: 42360
},

Géolocalisation des véhicules

URL : https://pysae.com/api/v2/groups/<group_id>/devices[/<device_id>]

Variables :

<groupe_id> : identifiant du groupe
<device_id> : identifiant de véhicule

Résultat : Renvoie la liste des véhicules du groupe et leurs informations.

Exemple : https://pysae.com/api/v2/groups/pysae/devices

Flux temps réel avec les données véhicules (Websocket)

URL : wss://pysae.com/api/v2/groups/<groupe_id>/updates/devices

Variables :

<groupe_id> : identifiant du groupe

Résultat : Ouvre un flux temps réel concernant les informations des véhicules

Notifications

URL: https://pysae.com/api/v2/groups/<groupe_id>/alerts

Variables:

<groupe_id>: identifiant du groupe

Résultat: renvoie la liste des notifications en cours pour le groupe et leurs informations

champ	Description	Statut
_id	Identifiant du message
header_text	Objet du message
active	Vaut "true" ou "false" en fonction du statut actif ou pas du message
description_text	Texte du message
informed_entity	Décrit les entité concernées par le message (une ou plusieurs ligne par exemple).
active_date_times	Décrit les dates pendant lesquelles le message est valable
start_date	Date de début de validité du message
end_date	Date de fin de validité du message
start_time	Début de l'heure de validité du message (chaque jour)	Rarement utilisé
end_time	Fin de l'heure de validité du message (chaque jour)	Rarement utilisé
daysOfWeek	Jours de la semaine pendant lesquels le message est valable. Le premier chiffre représente lundi. Le deuxième mardi, etc. 1 signifie que le message est valable pour ce jour là et 0 non.

Exemple: https://pysae.com/api/v2/groups/pysae/alerts

{

_id: "5f3aa9b543f0851866d77aea",

header_text: " déviation sur le réseau 301",

active: true,

description_text: "RESTER SUR L ITINÉRAIRE NORMAL PAS DE DÉVIATION MERCI ",

informed_entity: [],

{

route_id: "301"

}

active_date_times:
[{

start_date: "20200818",

end_date: "20200818",

start_time: "00:00:00",

end_time: "23:59:00",

daysOfWeek:
[0,1,0,0,0,0,0]

}]

}

Horaires de passage prévus aux arrêts

Géolocalisation des véhicules

Flux temps réel avec les données véhicules (Websocket)

Notifications

Articles associés