Skip to main content
All CollectionsData and external interfaces
Railnova - Generic HTTP REST API
Railnova - Generic HTTP REST API

Description and documentation of Railnova's generic HTTP REST API

Updated over 10 months ago

Railnova offers a Generic HTTP REST API on data to all Enterprise Customers available 24 hours a day under the following terms:

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

  • This 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.

  • It is used by our web front-end and is subject to change over time. Be sure to check the deprecation policy below.

  • This API is not designed for streaming large payloads of telematics data. If you want to retrieve or push telematic data to the Railnova platform, please view this article.

Authentication

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

If you do not have permission to create a new user on the Railnova platform, please contact your company administrator.

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 Railnova platform in the URL.

Environment: Test

Host: test.railnova.eu

Entry point: api/

Protocol: HTTPS

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.

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 Railnova - Generic HTTP REST API terms:

Note that you have the option to select "Pretty print" at the top of the page in order to display the API results with line breaks, making them easier to read.

Without pretty print:

With pretty print:

Rate-limiting

The Railnova - Generic HTTP REST API is rate-limited to avoid usage abuses. The limitations are as follows:

  • a burst rate of 50 requests per minute

  • a sustained rate of 360 requests per hour

These limits are set per identified user or client host across all endpoints.

Please bear in mind that the limit is reached after 7.2 minutes if you use the burst rate.

Note that if you’re querying telematics data, each minute of data counts as one request. The limits for the telematics endpoints (flat_event and telematics/events) can therefore be reached quickly if you request a large amount of data.
If you need a large amount of telematics data in a single step, we suggest that you use our Data Export feature described in this article.

When reaching this limit, all subsequent requests will receive a 429 HTTP error response containing information on when the next successful request will be accepted.

If this limit is too low for your usage, don't hesitate to reach us to our Sales team.

Deprecation Policy

Under these Railnova - 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 backward compatibility for six months (if you react within two weeks).

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

  • change of naming of an endpoint

  • removal of some data present in a used endpoint

  • change in the rate-limiting of our API

We provide no guarantees regarding the Railnova 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

Do you still have questions? Go to the Railnova platform and click "Contact us" for help!

Did this answer your question?