Dezelfde analyse als On-Prem-container in uw netwerk
De API is dezelfde analysekern als in het desktopprogramma, verpakt als container-image dat u On-Prem draait, dus op een eigen server of in uw cluster. Uw systemen sturen de kaartbestanden via HTTP naar de container en krijgen de analyse als JSON terug. De container houdt de kaartbestanden alleen in het werkgeheugen. Hij slaat ze niet op de harde schijf op en schrijft ze in geen enkel logbestand. Kaartbestanden en resultaten stuurt hij niet naar ons. Hij maakt verbinding met onze licentieserver op license.scernetta.com, zodat wij kunnen tellen hoeveel bestuurders u met uw licentie analyseert. Dat doet hij na het starten, ongeveer elke 6 uur en bij een nieuwe bestuurder. De licentieserver ontvangt daarbij de tekst van uw licentiebestand met uw bedrijfsnaam, het versienummer van de container, enkele technische controlewaarden en voor elke nieuwe bestuurder een bestuurderscode. De bestuurderscode berekent de container op uw server uit de bestuurderskaart en uw geheime sleutel.
Voor wie het bedoeld is
Bedoeld is dit voor vloten met een eigen TMS of ERP die de analyse daar verder willen verwerken. Telematica-aanbieders die kaartgegevens toch al inzamelen, kunnen ze daarmee direct laten controleren, en dienstverleners die bestuurderskaarten voor veel klanten analyseren, besparen zich de omweg via een desktopprogramma.
Hoe dat verloopt
U krijgt van ons een licentiebestand. Vóór de eerste start maakt u eenmalig met een opdracht uit het container-image een geheime sleutel aan, waaruit de container de bestuurderscodes berekent. Gebruik deze sleutel op alle installaties en bewaar er een kopie van. De container draait op een server in uw netwerk en heeft daar een eigen map nodig, waarin hij bijhoudt welke bestuurders al een bestuurdersplaats hebben. De server moet license.scernetta.com kunnen bereiken, direct of via uw HTTP-proxy. Uw systemen melden zich aan met een API-sleutel en leveren de .ddd-bestanden via HTTP aan, afzonderlijk of gebundeld per bestuurder, en de container voegt ze op dezelfde manier samen als het desktopprogramma doet. Terug komt een JSON met de diensten, de overtredingen in de gekozen weergave, de prognoses en de niet te beoordelen periodes, dat u direct verder kunt verwerken.
Voor een hele vloot in één keer is er een batch-eindpunt. U uploadt alle bestanden in één verzoek, de container wijst ze zelf toe aan de bestuurders en rekent op de achtergrond. Voor elke nieuwe bestuurder in het verzoek bezet de container al bij het indienen een bestuurdersplaats. Zijn er niet genoeg vrije bestuurdersplaatsen voor alle nieuwe bestuurders, dan wijst hij het hele verzoek af en bezet hij geen plaats. De voortgang en de resultaten per bestuurder vraagt u op via een job-ID.
Dezelfde kern
Het desktopprogramma en de API rekenen met dezelfde code. Voor hetzelfde bestand en dezelfde weergave levert de API dezelfde resultaten als het programma, als gegevens.
Twee weergaven
Elk antwoord bevat een van de twee overtredingslijsten. Standaard is de strenge weergave ingesteld, die elke bevinding afleidt uit de verordeningstekst en het bijbehorende artikel noemt. Volgens EU-recht kunt u in plaats daarvan de referentieweergave opvragen, die is gekalibreerd op het resultaat van gevestigde software. Volgens de Zwitserse regels ARV 1 en ARV 2 is er alleen de strenge weergave. Een eigen eindpunt levert de catalogus van de regels met hun vindplaatsen.
Rapporten
Het rapport uit het desktopprogramma komt ook via de API, als HTML of als CSV-tabellen in een zip. Daarbij een bronmanifest dat vastlegt welk geüpload bestand welke dag onderbouwt.
Echtheid
Handtekeningen en certificaten van een bestuurderskaart of een voertuigunit-download zijn via de API te controleren. Het antwoord zegt wat er is geverifieerd. Handtekeningen van de eerste kaartgeneratie controleert deze versie nog niet, dat is geen aanwijzing voor manipulatie.
Voertuigunit
Ook het downloadbestand van het voertuig is in te lezen. U ziet welke kaarten in een periode waren ingestoken en welke bestuurders daarmee hebben gereden.
Generaties
Gelezen worden bestuurderskaarten van generatie 1 en van generatie 2 inclusief versie 2. Bestanden van voertuigunits leest de API alleen in de formaten van generatie 2.
OpenAPI
De interface is beschreven als OpenAPI-3.1-specificatie, die de container zelf uitlevert. De documentatie op docs.scernetta.com wordt daaruit gegenereerd.
Hoe bestuurders worden geteld
Elke bestuurderskaart die u tijdens de looptijd van uw licentie analyseert, telt eenmaal als bestuurder, ongeacht hoe vaak u die analyseert. Krijgt een bestuurder een vernieuwde kaart of een vervangende kaart, dan blijft hij dezelfde bestuurder. Krijgt hij een kaart uit een ander land, dan telt hij als nieuwe bestuurder. Een bestuurder behoudt zijn bestuurdersplaats tot het einde van de looptijd, ook als hij uw onderneming eerder verlaat. Er wordt geteld over al uw installaties samen, ook een testinstallatie. De voorbeeldkaart van onze website, de echtheidscontrole en bestanden uit voertuigunits bezetten geen bestuurdersplaats.
Licentie
De API wordt naar het aantal bestuurders gelicentieerd en jaarlijks afgerekend. Of het licentiebestand echt is, controleert de container zelf aan de hand van de digitale handtekening, daarvoor heeft hij geen verbinding met ons nodig. Wordt een bestuurder in de looptijd voor het eerst geanalyseerd, dan vraagt de container bij onze licentieserver een bestuurdersplaats voor hem aan. Loopt een betaalde licentie af, dan rekent de container nog 14 dagen door, zodat de analyse niet stilvalt als de verlenging een paar dagen later komt. De prijs noemen wij op aanvraag, omdat die afhangt van de grootte van de vloot.
Zonder verbinding met de licentieserver
Bestuurders die al een bestuurdersplaats hebben, analyseert de container ook zonder verbinding met onze licentieserver verder, 30 dagen lang vanaf de laatste verbinding, met een proeflicentie 14 dagen. Voor nieuwe bestuurders heeft een betaalde licentie een reserve, voor het geval onze licentieserver langer dan een minuut niet bereikbaar is. De reserve is een tiende van de bestuurdersplaatsen, maar minstens 2 plaatsen per looptijd, bij 30 plaatsen dus 3. Daarvoor heeft de container zijn map op de server nodig. Deze bestuurders meldt hij achteraf, zodra de licentieserver weer bereikbaar is. Een proeflicentie heeft geen reserve.
Wat de server verlaat
De kaartbestanden worden On-Prem verwerkt, dus in uw netwerk, en nooit aan ons overgedragen. De bestuurderscode berekent de container op uw server uit de bestuurderskaart en uw geheime sleutel, die wij nooit krijgen. Wij kunnen uit de code niet afleiden wie de bestuurder is. Met uw sleutel kan de code echter weer aan een bestuurder worden gekoppeld, daarom behoort hij volgens de AVG tot de persoonsgegevens. De laatste 20 berichten die de container sinds zijn start naar onze licentieserver heeft gestuurd, kunt u bij de container opvragen en lezen, zoals ze er vóór de versleuteling uitzagen.
De documentatie van de interface staat op docs.scernetta.com en wordt uit het OpenAPI-bestand gegenereerd. Ze begint met een handleiding voor start, licentie en foutafhandeling en beschrijft elk eindpunt met zijn parameters.Naar de documentatie
Wilt u de API inzetten, schrijf ons dan welke systemen u wilt koppelen en om hoeveel bestuurders of voertuigen het gaat. Wij nemen dan contact met u op over een toegang.