Railnova biedt een Algemene HTTP REST API op gegevens aan alle Enterprise klanten die 24 uur per dag beschikbaar is onder de volgende voorwaarden.
De Algemeen HTTP REST API biedt externe diensten de mogelijkheid om met resources te communiceren, zoals operationele statussen van assets, onderhoudsevents, interventies en tellers.
Deze API wordt meestal als interface met oudere CMMS-systemen, ERP-systemen, ECM-systemen (Entity in Charge of Maintenance) en Business Intelligence-systemen van derden gebruikt, zoals PowerBI, QlikSense, Tableau of Looker.
Hij wordt door onze web front-end gebruikt en kan in de loop van de tijd wijzigen. Controleer het onderstaande deprecatiebeleid.
Deze API is niet ontworpen voor het streamen van grote hoeveelheden telematicagegevens. Als je regelmatig telematicagegevens wilt ophalen of naar het Railnova platform verzenden, bekijk dan dit artikel.
Authenticatie
Authenticatie gebeurt via Basic Authentication (over HTTPS) met een Railnova gebruikersnaam en wachtwoord. We adviseren je een specifieke gebruiker voor elke interface aan te maken die je met de API van Railnova wilt implementeren.
Als je niet over de rechten beschikt om een nieuwe gebruiker op het Railnova platform aan te maken, neem dan contact op met de beheerder van je bedrijf.
Omgevingen
Omgeving: Productie
Host: [jouw-bedrijf].railnova.eu
Ingangspunt: api/
Protocol: HTTPS
URL voorbeeld: https://[jouwbedrijf].railnova.eu/api/
> Belangrijk: je moet [jouw-bedrijf] vervangen door je bedrijfssleutel. Deze sleutel kun je vinden wanneer je het Railnova platform in de URL opent.
Omgeving: Test
Host: test.railnova.eu
Ingangspunt: api/
Protocol: HTTPS
URL-voorbeeld: https://test.railnova.eu/api/
Paginering
Het grootste deel van onze API REST-interface is gepagineerd om de beste prestaties te garanderen.
Gepagineerde endpoints sturen standaard 50 elementen terug. Je kunt extra pagina's met de pagina parameter in je HTTPS GET verzoek specificeren.
Voorbeeld: https://one.railnova.eu/api/counters/?page=2
Opmerking: Je hoeft de pagina-parameter niet op te geven om de eerste pagina van het resultaat te krijgen. Als de pagina-queryparameter niet wordt opgegeven, zal het systeem de waarde standaard op 1 zetten.
De header van de antwoorden op je verzoeken bevat paginagegevens (https://tools.ietf.org/html/rfc8288) en zou er ongeveer zo uit moeten zien* :
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"
*Het voorbeeld bevat regels voor de leesbaarheid.
De mogelijke waarden zijn:
volgende | De link naar voor de onmiddellijk volgende pagina met resultaten. |
eerste | De link naar voor de eerste pagina met resultaten. |
prev | De link naar voor de vorige pagina met resultaten. |
laatste | De link naar voor de laatste pagina met resultaten. |
Er zijn meerdere informatiebronnen op het internet over het analyseren van Link Header paginering in verschillende programmeertalen; hier zijn er een paar:
Javascript: https://www.npmjs.com/package/parse-link-header
Beschikbare inhoud & voorbeelden
De volgende eindpunten vallen onder de Railnova - Algemene HTTP REST API voorwaarden:
Restricties: https://one.railnova.eu/api/asset_restriction/
Operationele status: https://one.railnova.eu/api/asset_operational_status/
Interventies: https://one.railnova.eu/api/intervention/
Onderhoudsevents: https://one.railnova.eu/api/maintenance/
Tellers: https://one.railnova.eu/api/counters
Je kunt de optie "Pretty print" bovenaan de pagina selecteren om de API resultaten met regeleinden weer te geven zodat ze makkelijker te lezen zijn.
Zonder "pretty print":
Met "pretty print":
Snelheidsbeperking
De Railnova - Algemeen HTTP REST API is gelimiteerd om misbruik te voorkomen. De beperkingen zijn als volgt:
Een burstsnelheid van 50 verzoeken per minuut
Een aanhoudende snelheid van 360 verzoeken per uur
Deze limiet geldt per gebruiker en voor alle endpoints.
Onthoud dat de limiet na 7,2 minuten is bereikt als je de burstsnelheid gebruikt.
Hou er rekening mee dat als je telematicagegevens opvraagt, telt elke minuut aan gegevens als één aanvraag. De limieten voor de telematica-eindpunten (flat_event en telematics/events) kunnen dus snel bereikt worden als je een grote hoeveelheid data opvraagt.
Als je een grote hoeveelheid telematicagegevens in een keer nodig hebt, adviseren we je om onze functie “Gegevens exporteren” te gebruiken zoals uitgelegd in dit artikel.
Bij het bereiken van deze limiet krijgen alle volgende verzoeken een 429 HTTP foutmelding met informatie over wanneer het volgende succesvolle verzoek zal worden geaccepteerd.
Als deze limiet te laag is voor je gebruik, aarzel dan niet om ons Sales team te contacteren.
Deprecatie beleid
Onder deze Railnova - Algemeen HTTP REST API voorwaarden, willen we ervoor zorgen dat onze klanten geïnformeerd worden en de tijd hebben om hun systemen te updaten voor ingrijpende veranderingen plaatsvinden, terwijl de normale functie- en productontwikkeling workflows bij Railnova mogelijk blijven.
Een functierelease kan bepaalde functies uit eerdere releases vervangen ("een ingrijpende wijziging"). Wanneer we ingrijpende wijzigingen uitbrengen, informeren we je vóór de releasedatum over de ingrijpende wijzigingen en garanderen we dat de wijzigingen zes maanden lang terug compatibel zijn (als je binnen twee weken reageert).
Dit soort wijzigingen worden beschouwd als "breaking" in de Railnova API:
wijziging van de naam van een eindpunt
verwijdering van bepaalde gegevens in een gebruikt eindpunt
wijziging van de snelheidsbeperking van onze API
Wij bieden geen garanties met betrekking tot de Railnova Algemene API op:
het toevoegen van nieuwe endpoints
toevoegen van extra informatie aan bestaande endpoints
Om over ingrijpende wijzigingen geïnformeerd te worden, moet je je gebruik van de api hier registreren: https://forms.gle/tNRDb82996PkKRk79
Support
Heb je nog vragen? Ga naar het Railnova-platform en klik op "Contact" voor hulp.