Telematicaportaal & app

Gegevensinterface API

De externe standaard pushservice is de service voor het delen van boxgegevens met externe aanbieders/klanten die geen Krone-portaal hebben. Voor dit doel kan de eigenaar van de voertuigen (boxgegevens) een provider aanmaken met een URI in het DataCentre waarnaar de gegevens moeten worden verzonden. Voor deze provider kan dan een sharing worden aangemaakt, waarbij het mogelijk is om te selecteren welke van de voertuigen die tot het portaal behoren, moeten worden gedeeld met de gespecificeerde provider.

Om het delen van deze gegevens soepel te laten verlopen, moet de gespecificeerde URI verwijzen naar het API-eindpunt waar de externe provider/klant de gegevenspakketten wil ontvangen.

De gegevens die we versturen zijn beschikbaar als JSON. De exacte structuur is te vinden in de volgende Swagger documentatie (RequestBody).

Als er fouten optreden tijdens de gegevensoverdracht, is het belangrijk dat de foutreactie die naar ons wordt gestuurd een JSON in de body bevat, die is gestructureerd volgens het gedocumenteerde formaat (ErrorResponseBody). Dit is de enige manier om ervoor te zorgen dat er geen gegevenspakketten worden weggegooid en dat ze opnieuw worden verzonden nadat een tijdslimiet is verstreken.

Het schema van de gebruikersgegevens is gedocumenteerd als RequestData en bevat, naast de externe klant-ID, de volledige gegevensrecord van de box/voertuig die werd vrijgegeven via een uitwisseling.

De complexiteit en structuur van de JSON van de gebruikersgegevens hangt af van de gegevens die een box verstuurt en kan daarom variëren. De documentatie bevat daarom alleen een voorbeeldstructuur. De ontvanger is verantwoordelijk voor het verwerken van de feitelijke gegevens en dus ook voor het analyseren van de specifieke gegevenspakketten. We bereiden de gegevensrecords altijd van tevoren voor, zodat er geen lege velden zijn en de structuur gesorteerd is.