The real-time data collected by Ara can be retrieved by using several protocols, especially the SIRI protocol.
The remote system should use a SIRI client to retrieve the real-time data, according to the capacities of this client, Ara SIRI API can be used in different ways:
using StopMonitoring or EstimatedTimetable service
using request or subscription mode
The choice depends on the effective capacities of the remote system and its SIRI support. In Ara, you can select in the user interface which kind of services and protocols will be available for this Partner.
Most of the time, you should create a Partner dedicated to this new SIRI exchange.
According to the expected SIRI exchange, you will setup the required connectors:
Add to the associated Partner these 3 connectors:
CheckStatus server
StopPointsDiscovery broadcaster
StopMonitoring request broadcaster
These connectors will require only 2 settings:
the local credential chosen to identify this Partner
the code type to be used to interact with this Partner (see code management).
With these connectors, the remote SIRI server will be able:
to check the status of our real-time Ara referential (via CheckStatus SIRI service)
to retrieve the list of stop places (via StopPointsDiscovery SIRI service)
the next calls of each Stop Place (via StopMonitoring SIRI service)
The remote SIRI server provider will ask you:
the Ara SIRI endpoint of our referential: https://ara-api.enroute.mobi/<short-name>/siri
the Ara local credential that you have chosen to identify this Partner
If the remote system can support SIRI subscriptions, you should prefer this approach. |
Add to the associated Partner, these 4 connectors:
CheckStatus server
CheckStatus client
StopPointsDiscovery broadcaster
StopMonitoring subscription broadcaster
These connectors will require only 4 settings:
the SIRI endpoint of the remote system (a public HTTPS URL)
the local credential chosen to identify this Partner
the remote credential chosen by the remote system to identify Ara
the code type to be used to interact with this Partner (see code management).
With these connectors, the remote SIRI server will be able:
to check the status of our real-time Ara referential (via CheckStatus SIRI service)
to retrieve the list of stop places (via StopPointsDiscovery SIRI service)
to subscribe to each Stop Place (via StopMonitoring SIRI service) and receive StopMonitoring notifications on its remote SIRI endpoint
The remote system must support:
the CheckStatus SIRI service
the StopMonitoring notification service
The complete documentation with examples for all SIRI exchanges are available in the Ara Broadcast API - SIRI interfaces document.
