Railnova offre une API générique HTTP REST sur les données Railnova à tous ses clients, disponible 24 heures sur 24, selon les conditions suivantes :

L'API générique HTTP REST permet aux services externes d'interagir avec les ressources, telles que les états opérationnels des matériels roulants, les événements de maintenance, les interventions et les compteurs.
Cette API est généralement utilisée pour communiquer avec les systèmes de GMAO existants, les ERP, les systèmes ECM (Entité en charge de la maintenance) et les systèmes de Business Intelligence tiers tels que PowerBI, QlikSense, Tableau ou Looker.
Elle est utilisée par notre interface web et est amenée à évoluer au fil du temps. Veillez à consulter la politique d'obsolescence ci-dessous.
Cette API n'est pas conçue pour la diffusion en continu de grandes quantités de données télématiques. Si vous souhaitez récupérer ou envoyer des données télématiques vers la plateforme Railnova, veuillez consulter cet article.

Authentification

L'authentification se fait via l'authentification de base (via HTTPS) avec un nom d'utilisateur et un mot de passe Railnova. Nous vous recommandons de créer un utilisateur spécifique pour chaque interface que vous allez mettre en œuvre avec l'API de Railnova.

Si vous n'avez pas l'autorisation de créer un nouvel utilisateur sur la plateforme Railnova, veuillez contacter l'administrateur Railnova de votre entreprise.

Environnements

Environnement : Production

Host : [votre-entreprise].railnova.eu

Point d'entrée : api/

Protocole : HTTPS

Exemple d'URL : https://[votreentreprise].railnova.eu/api/

> Important : Vous devez remplacer [votre-entreprise] par la clef de votre entreprise. Cette clef se trouve dans l'URL quand vous visitez la plateforme Railnova.

Environnement : Test

Host : test.railnova.eu

Point d'entrée : api/

Protocole : HTTPS

Exemple d'URL : https://test.railnova.eu/api/

Pagination

La plupart des interfaces REST de notre API sont paginées afin de garantir les meilleures performances.

Les points d'accès paginés renvoient 50 éléments par défaut. Vous pouvez spécifier des pages supplémentaires à l'aide du paramètre page dans votre requête HTTPS GET.

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

Remarque : il n'est pas nécessaire d'indiquer le paramètre page pour obtenir la première page du résultat. Si le paramètre de requête page n'est pas fourni, le système lui attribue par défaut la valeur 1.

L'en-tête des réponses à vos demandes comprend des informations sur la pagination (https://tools.ietf.org/html/rfc8288) et devrait ressembler à ceci* :

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"

*L'exemple inclut des sauts de ligne pour une meilleure lisibilité.

Les valeurs possibles sont :

next	accéder à la page de résultats suivante.
first	accéder à la première page des résultats.
prev	accéder à la page de résultats précédente.
last	accéder à la dernière page des résultats.

Il existe de nombreuses ressources sur Internet concernant l'analyse de la pagination des en-têtes dans une variété de langages de programmation ; en voici quelques-unes :

Contenu disponible et exemples

Les points de terminaison suivants sont couverts par les termes de Railnova - Generic HTTP REST API :

Restrictions : https://one.railnova.eu/api/asset_restriction/
Statut opérationnel : https://one.railnova.eu/api/asset_operational_status/
Interventions : https://one.railnova.eu/api/intervention/
Événements de maintenance : https://one.railnova.eu/api/maintenance/
Compteurs : https://one.railnova.eu/api/counters

Notez que vous avez la possibilité de sélectionner "Pretty print" en haut de la page afin d'afficher les résultats de l'API avec des retours à la ligne, ce qui les rend plus faciles à lire.

Sans "pretty print":

Avec "pretty print":

Limitation

L'API REST HTTP générique de Railnova est limitée pour éviter les abus d'utilisation. Les limitations sont les suivantes :

Max. 50 requêtes par minute (burst rate, ou taux élevé)
Max. 360 requêtes par heure (sustained rate, ou taux continu)

Ces limites sont fixées par utilisateur identifié ou par client host pour tous les points de terminaison.

N'oubliez pas que la limite est atteinte au bout de 7,2 minutes si vous utilisez le burst rate (taux élevé).

Notez que si vous interrogez des données télématiques, chaque minute de données compte pour une requête. Les limites des points de terminaison télématiques (flat_event et telematics/events) peuvent donc être rapidement atteintes si vous demandez une grande quantité de données.

Si vous avez besoin de récupérer une grande quantité de données télématiques d'un coup, nous vous suggérons d'utiliser notre fonction d'export de données décrite dans cet article.

Lorsque cette limite est atteinte, toutes les demandes suivantes recevront une réponse d'erreur HTTP 429 contenant des informations sur la date à laquelle la prochaine demande réussie sera acceptée.

Si cette limite est trop basse pour votre utilisation, n'hésitez pas à contacter notre équipe commerciale.

Politique de dépréciation

Dans le cadre des présentes conditions d'utilisation de Railnova - Generic HTTP REST API, nous voulons nous assurer que nos clients sont informés et qu'ils ont le temps de mettre à jour leurs systèmes avant les changements radicaux, tout en permettant à Railnova d'assurer le développement normal des fonctionnalités et des produits.

Une version de fonctionnalité peut rendre obsolètes certaines fonctionnalités des versions précédentes ("breaking change"). Lorsque nous publions des changements majeurs, nous vous en informons avant la date de leur mise en place et nous assurons la compatibilité ascendante pendant six mois (si vous réagissez dans les deux semaines).

Les modifications considérées comme des "ruptures" dans le cadre de l'API sont les suivantes:

changement de nom d'un point d'accès
suppression de certaines données présentes dans un point d'accès utilisé
changement dans la limitation du taux de notre API

Nous ne fournissons aucune garantie concernant l'API générique de Railnova sur :

l'ajout de nouveaux points d'accès
l'ajout d'informations supplémentaires à des points d'accès existants

Afin d'être informé des changements importants, vous devez enregistrer votre utilisation de l'API ici : https://forms.gle/tNRDb82996PkKRk79

Support

Vous avez encore des questions ? Rendez-vous sur la plateforme Railnova et cliquez sur "Nous contacter" pour obtenir de l'aide !