Railnova offers a Generic HTTP REST API on Railfleet data to all Enterprise Customers under the following terms.

The Railfleet - Generic HTTP REST API allows external services to interact with Railfleet resources such as operational statuses of assets, maintenance events, interventions, counters.

The Railfleet - Generic HTTP REST API is typically used to interface with legacy CMMS systems, ERPs, ECM (Entity in Charge of Maintenance) systems and third party Business Intelligence systems such as PowerBI, QlikSense, Tableau, or Looker.

The Railfleet - Generic HTTP REST API is used by our web front-end and subject to change over time. Be sure to check the deprecation policy below.

This API is not designed for streaming large payload of telematics data. If you want to retrieve or push telematic data to Railfleet, please view this article or contract support@railnova.eu.

Authentication

Authentication is done via Basic Authentication (over HTTPS) with a Railfleet user’s name and password. We recommend that you create a specific user for each interface you will implement with Railfleet’s API.

If you do not have the rights to create a new user into Railfleet, please contact your company administrator or our support at support@railnova.eu, and we will be happy to help you in this setup.

Environments

Environment: Production

Host: [your-company].railnova.eu

Entry point: api/

Protocol: HTTPS

URL example: https://[yourcompany].railnova.eu/api/

> Important: You must replace [your-company] with your company key. This key can be found when you visit the Railfleet platform in the URL.

Environment: Test

Host: test.railnova.eu

Entry point: api/

Protocol: HTTPS

URL example: https://test.railnova.eu/api/

Pagination

Most of our API REST interface is paginated to ensure the best performance.

Paginated endpoints will return 50 elements by default. You can specify additional pages with the page parameter in your HTTPS GET request.

Example: https://one.railnova.eu/api/counters/?page=2

Note: You do not have to provide the page parameter to get the first page of the result. If the page query parameter is not provided, the system will default its value to 1.

The header of the responses to your requests includes paging information (https://tools.ietf.org/html/rfc8288) and should look similar to this* :

Link: <https://one.railnova.eu/api/counters/?page=3>; rel="next", <https://one.railnova.eu/api/counters/?page=2>; rel="previous", <https://one.railnova.eu/api/counters/?page=30>; rel="last", <https://one.railnova.eu/api/counters/?page=1>; rel="first"

*The example includes line breaks for readability.

The possible values are :

next

The link relation for the immediate next page of results.

first

The link relation for the first page of results.

prev

The link relation for the immediate previous page of results.

last

The link relation for the last page of results.

There exist multiple resources on the internet on parsing Link Header pagination in a variety of programming languages; here are a few of them:

Available content & examples

The following endpoints are covered by the Railfleet - Generic HTTP REST API terms:

Deprecation Policy

Under these Railfleet - Generic HTTP REST API terms, we want to ensure that our customers are informed and have time to update their systems in advance of the breaking changes while allowing normal feature and product development workflows at Railnova.


A feature release may deprecate certain features from previous releases ("a breaking change"). When release breaking changes, we will notify you before the release date of the breaking changes and ensure backwards compatibility for 6 months.

These types of changes are considered "breaking" in the Railfleet API:

  • change of naming of an endpoint

  • removal of some data present in a used endpoint

We provide no guarantees regarding the Railfleet generic API on:

  • adding new endpoints

  • adding additional information to existing endpoints

In order to be notified of breaking changes, you must register your usage of the api here: https://forms.gle/tNRDb82996PkKRk79

Support

For any question about the Railfleet generic HTTP API, please contact us at support@railnova.eu

Did this answer your question?