API-documentatie

Met een geldige sleutel berekent estimate de heffing over heffingskilometers. Zonder sleutel blijft het 401. Een ontbrekende heffing komt terug als null, niet als 0.

Health

GET /api/v1/?endpoint=health is publiek. Een korte vorm /api/v1/health verwijst daarnaartoe. Zonder antwoord van de route-engine is de status degraded, niet een geslaagde check met nul routes.

Estimate en account

POST /api/v1/?endpoint=estimate en GET /api/v1/?endpoint=account eisen Authorization: Bearer. Zonder geldige sleutel komt 401 terug en wordt er geen heffing berekend. Een sleutel wordt per partner geactiveerd; er is geen open firehose.

Integratie

Een boekhoudpakket of TMS stuurt vertrek, bestemming en voertuigprofiel. HeffingCheck antwoordt met route- en heffingsindicatie plus factuurtekst. Het voertuigprofiel komt uit het wagenpark: kenteken, lengte, breedte, hoogte, gewichtsklasse en euroklasse.