/
Broadcast real-time data using SIRI

Broadcast real-time data using SIRI

The real-time data collected by Ara can be retrieved through several protocols, in particular SIRI and SIRI Lite, as well as the GTFS-RT extension.

The remote system must use a SIRI client to retrieve the real-time data. Depending on the client’s capabilities, Ara’s SIRI API can be used in different ways:

  • using the StopMonitoring or EstimatedTimetable services

  • using request or subscription mode

This choice depends on the actual capabilities of the remote system and its SIRI compatibility. In Ara, you can select in the user interface which types of services and protocols are available for a given Partner.

Create a Partner

Most of the time, you need to create a Partner dedicated to this new SIRI exchange.

You will configure the required connectors depending on the desired SIRI exchange:

Allow StopMonitoring SIRI requests

Add the following 3 connectors to the Exchange Partner:

  • SIRI CheckStatus Server

  • SIRI StopPointsDiscovery Request Broadcaster

  • SIRI StopMonitoring Request Broadcaster

These connectors require only 2 settings:

  • the local credential chosen to identify the partner: local_credential

  • the code type to use to interact with this partner: remote_code_space

Through these connectors, the remote SIRI server will be able to:

  • check the status of your real-time Ara referential (via the SIRI CheckStatus service)

  • retrieve the list of stop points (via the SIRI StopPointsDiscovery service)

  • get the subsequent calls at each stop point (via the SIRI StopMonitoring service)

The remote SIRI server provider will ask you for:

  • the endpoint of your Ara SIRI referential: https://ara-api.enroute.mobi/<short-name>/siri

  • the local Ara credential you have chosen to identify this partner

Allow StopMonitoring SIRI subscriptions

If the remote system supports SIRI subscriptions, you should prefer this approach.

Add the following 4 connectors to the Exchange Partner:

  • SIRI CheckStatus Server

  • SIRI CheckStatus Client

  • SIRI StopPointsDiscovery Request Broadcaster

  • SIRI StopMonitoring Subscription Broadcaster

These connectors require only 4 settings:

  • Ara’s public URL, sent to the remote system (SIRI Address / ConsumerAddress field) so it knows where to push notifications: local_url

  • the local credential chosen to identify this partner: local_credential

  • the remote credential chosen by the remote system to identify Ara: remote_credential

  • the code type to use to interact with this partner: remote_code_space

Through these connectors, the remote SIRI server will be able to:

  • check the status of our real-time Ara referential (via the SIRI CheckStatus service)

  • retrieve the list of stop points (via the SIRI StopPointsDiscovery service)

  • subscribe to each stop point (via the SIRI StopMonitoring service) and receive StopMonitoring notifications on its remote SIRI endpoint

The remote system must support:

  • the SIRI CheckStatus service

  • the StopMonitoring notification service

For the full description of all parameters, see Ara Partner Parameters.

Technical documentation

The complete documentation with examples for all SIRI exchanges is available in the Ara Broadcast API - SIRI interfaces document.