The SIRI interface (Service Interface for Real time Information) - is a protocol for exchanging real time information for public transport (XML format).
Access point
There are 2 ways of connecting to the SIRI real time service provided by Pysae:
Public access: limited to 1 request per second
Authenticated access (API-KEY): no restrictions
To generate an API KEY you need to :
Create an account on the API Management platform: https://api.okina.fr/user/registration
Log in
Subscribe to the API: https://api.okina.fr/catalog/api/29dd69b7-09e6-4eee-9d69-b709e60eee17/subscribe
Choose "authenticated access", then click Next
Select "Default application" from the drop-down list and fill in the volume of use field, then validate.
Wait for the request to be validated manually
Retrieve the API Key in "Applications" > "Subscriptions" and by clicking on the API key
Limits by type of access
Free access :
limited to Siri
limited to request mode
limited to 1 request per second
Authenticated access
access to Siri and Siri Lite
access to request mode and subscription mode
no frequency limit
Available Siri services
The following services are available in "request" or "subscription" mode:
CheckStatus
StopPointsDiscovery
LinesDiscovery
StopMonitoring
VehicleMonitoring
EstimatedTimetable
Situation Exchange
Siri request format
Siri requests can be sent in raw XML or SOAP format. The endpoints must be adapted according to the format the user wishes to use:
raw XML format :
https://api.okina.fr/gateway/[account name]/realtime/anshar/services
https://api.okina.fr/gateway/[account name]/realtime/anshar/subscribe
SOAP format :
https://api.okina.fr/gateway/[account name]/realtime/anshar/ws/services
https://api.okina.fr/gateway/[account name]/realtime/anshar/ws/subscribe
Example of a real time service request
Here is an example of how to access the Cars Faure real-time service on SYTRAL.
The basic URL for accessing the services is as follows: https://api.okina.fr/gateway/fau/realtime/
All the services are documented here: https://api.okina.fr/catalog/api/29dd69b7-09e6-4eee-9d69-b709e60eee17/doc?page=363ff9f9-1dce-4126-bff9-f91dce1126d7
Example of a request to the /anshar/services (Don't forget to fill in the API-KEY generated earlier) :
Sample response: