Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page contains all information relevant for connecting to Ruter’s real time platform.

Introduction

Ruter, as the Public Transport Authority (PTA) of Greater Oslo, offers a complete API for all aspects of realtime communication between vehicles and the Ruter backoffice. Based on position, automated passenger counting (APC) and other sensor data from vehicles, Ruter’s backend platform generates aggregated services both for consumption in the vehicle, on stop displays, as well as Ruter’s own operation control and data analysis.

The Vehicle API is based on a set of MQTT topics being standardised by the European organization ITxPT to facilitate easier and more transparent integration between services from vehicle manufacturers, system providers, Public Transport Operators (PTOs) and PTAs.

During Autumn 2019, the first official version of the complete ITxPT MQTT topic structure will be released, and Ruter’s API will as far as possible align with the standardised topics.and Ruter are developing their specifications in as close cooperation as possible. To learn more about this, see our blog post about this on-going process.

OTA Messages

Over-the-air messages are messages are exchanged between Ruter and vehicles using MQTT. The following information is available:

Signon/-off Procedures

Procedures for sending Signon and Signoff messages from vehicles.

Telemetry concept

How we are mapping sensor data in vehicles to our telemetry MQTT topic.

Platform versioning

The Vehicle API platform is currently on v1.0 after the production launch in April 2019. To keep up with market and tech development, the platform will be versioned according to a major and minor scheme. New and changed features will appear in new versions, and older versions will eventually be deprecated..

Look out for more information about this during the coming months.

Vehicle Registry API

Public Transport Operstors (PTO) can, after agreement, synchronize their Vehicle Registries with Ruter's registry by exposing a REST API with essential vehicle data. Ruter will then poll these data regularly to synchronize the central vehicle registry containing vehicles from all PTOs.API documentation

The API schema is available on our Github pages.