Ce document décrit l’interface SIRI sur PYSAE.
L'interface SIRI (pour Service Interface for Real time Information) – est un protocole d’échange de l’information Temps Réel pour les transports collectifs (format XML).
Point d'accès
Il existe 2 moyens de se connecter au temps réel SIRI mis à disposition par Pysae:
Accès public : limité à 1 requête par seconde
Accès authentifié (API-KEY) : aucune restriction
Pour générer une API KEY il faut :
Se créer un compte sur la plateforme d'API Management : https://api.okina.fr/user/registration
Se connecter
Souscrire à l'API : https://api.okina.fr/catalog/api/29dd69b7-09e6-4eee-9d69-b709e60eee17/subscribe
Choisir "accès authentifié", puis cliquer sur Suivant
Sélectionner "Default application" dans la liste déroulante et remplir le champs concernant la volumétrie d'utilisation, puis Valider
Attendre la validation manuelle de la demande
Récupérer l'API Key dans "Applications" > "Souscriptions" et en cliquant sur l'API key
Limites par type d'accès
Accès libre :
limité au Siri
limité au mode requête
limité à 1 requête par seconde
Accès authentifié
accès au Siri et Siri Lite
accès au mode requête et mode abonnement
pas de limite de fréquence
Services Siri disponibles
Les services suivants sont disponibles en mode "requête" ou "abonnement":
CheckStatus
StopPointsDiscovery
LinesDiscovery
StopMonitoring
VehicleMonitoring
EstimatedTimetable
Situation Exchange
Format des requêtes Siri
Les requêtes Siri peuvent être envoyées au format XML brut ou SOAP. Les endpoints devront être adaptés selon le format que l'utilisateur souhaite utiliser :
format XML brut :
format SOAP
Exemple d'interrogation du service temps réel
Voici un exemple d'interrogation du service temps réel des Cars Faure sur le SYTRAL.
L'url de base pour accéder aux services est la suivante : https://api.okina.fr/gateway/fau/realtime/
L'ensemble des services sont documentés ici : https://api.okina.fr/catalog/api/29dd69b7-09e6-4eee-9d69-b709e60eee17/doc?page=363ff9f9-1dce-4126-bff9-f91dce1126d7
Exemple de requête sur le service /anshar/services (Sans oublier de renseigner l'API-KEY générée précédemment) :
Exemple de réponse:
