Getting started

Owned by Karoline Mortensen
Last updated: Dec 02, 2019 by Torbjørn Barslett
2 min read

In order to connect to Ruter Vehicle API, there are some preparations that need to be done:

Register

You need to be a PTO or other operator/integrator already under a contractual agreement with Ruter to register for access to the Vehicle API. If that is taken care of, contact us at rdp-support@ruter.no for connection details.

Ensure vehicle compliance

Your vehicles need to comply with the following minimum requirements to be allowed acces to the Vehicle API.

  • Technical installations in the vehicle must comply with ITxPT specification S01
  • Services in the vehicle must comply with ITxPT specification S02.
  • The vehicle must bridge all necessary MQTT topics over the air to and from Ruter's MQTT endpoint without delay.
  • The vehicle must identify at all times with the Vehicle Identification Number (VIN).
  • To utilise the DPI service, all displays in the vehicle need to comply to the approved display sizes, resolutions and form factors.

Site to site compliance

Users of the Vehicle API can give Ruter access to their Vehicle and Equipment Registry (VER) through a REST API. This API should be structured according to Ruter's latest schema. 

All communication between  the vehicle bridge and Ruter's endpoint must be secure. This is usually achieved by sending MQTT data between the vehicle and the PTO central MQTT broker through a private mobile APN, then establishing a Secure MQTT connection further to Ruter's MQTT endpoint. In this manner, there is no need to handle a certificate infrastructure on the vehicles. Please note that Ruter does not support VPNs terminated at their backoffice except if specifically agreed.

Validation of data

All transmitted data must validate against Ruter's Over-The-Air schemas.

Which data to transmit to Ruter?

The basic requirement is to continually (every 1-2 seconds) transmit vehiclke positions as avl/json . At the start of a service, the block to be serviced needs to be trsansmitted along with the Vehicle ID in a signon/json telegram. If the signon is accepted, you will start to receive DPI message as the vehicle moves along the upcoming journeys.