API vtlb-calculator
Softwareontwikkelaars kunnen zich vanaf nu aanmelden voor de API-key van de nieuwe vtlb-calculator. Wilt u de vtlb-calculator integreren in uw eigen software? Met de API-key krijgt u toegang tot de applicatie en koppelt u uw software eenvoudig aan de calculator. Zo voert u direct vanuit uw eigen applicatie nauwkeurige vtlb-berekeningen uit.
Aanvragen API keys
Wil uw bedrijf gebruikmaken van de API? Meld u aan via het aanmeldformulier API vtlb-calculator. Hierbij verwerkt Bureau Wsnp uw gegevens alleen in het kader van de API. Wij delen uw gegevens met Kred’it, de ontwikkelaar van de vtlb-calculator.
test- en productieversie
Er bestaat een test- en productversie. In het aanmeldformulier kunt u aangeven welke API keys u wilt afnemen. U kunt zich voor beide versies aanmelden.
Beide keys blijven geldig tot juli 2028
Technische ondersteuning
Technische vragen kunt u stellen aan Kred'it, de ontwikkelaar van de vtlb-calculator, per e-mail via [email protected] of telefonisch via +31 (0)40 ‑ 239 3232.
U vindt hier de informatie voor de vtlb-api. In plugin in/uitvoer technisch (xlsx, 61 kB) vindt u de oude en nieuwe velden.
Productieversie
- Vtlb-calculator: https://www.vtlb.rvr.org/home
- Vtlb-api: https://www.vtlb.rvr.org/v51/api
- Vtlb-api documentatie:
Testversie (acceptatie)
- Vtlb-calculator: https://www.acc-vtlb.rvr.org/home
- Vtlb-api: https://www.acc-vtlb.rvr.org/v51/api
- Vtlb-api documentatie:
VTLB API – aansluiten
Documentatie
- Scalar: https://www.vtlb.rvr.org/v51/scalar/vtlb#tag/vtlbapp.
- OpenAPI (JSON): https://www.vtlb.rvr.org/v51/openapi/vtlb.json.
Hiermee kun je een client genereren.
Requests, responses, velden en validatieregels staan in Scalar. Hieronder staat alleen wat je daar niet direct ziet.
Base-URL en versie
- https://www.vtlb.rvr.org/v51/api/VTLBApp/<actie>
- v51 is de VTLB-versie (5.1).
Elk halfjaar komt er een nieuwe versie met een eigen pad. Maak het pad daarom configureerbaar.
Authenticatie
- Stuur bij elke aanroep de header X-Vtlb-Subscription-Key: <key> mee.
- De key telt 40 tekens (letters en cijfers). Je krijgt hem van Kredit. Bewaar hem in je configuratie of secret store, nooit in code.
- Ontbreekt de key of is hij ongeldig, dan krijg je 400 met de tekst “Missing or invalid header”. Je krijgt dus geen 401.
Conventies
- JSON, met Content-Type: application/json.
- Datums gebruiken het formaat yyyy-MM-dd, bijvoorbeeld "2026-07-01".
- Bijna alle acties zijn POST. Alleen GetVersieRecord is GET.
- Elke response heeft dezelfde envelop: { "data": …, "success": true|false, "message": "…" }.
Belangrijkste acties
|
Actie |
Doel |
|---|---|
|
GET GetVersieRecord |
Actieve VTLB-versie. Handig als verbindingstest. |
|
POST GetVTLBBerekening |
Volledige berekening. Geeft PDF, XML en BVV-portaalmeldingen terug. |
|
POST GetVTLBNormen |
Normen op een datum (PDF en XML) |
|
POST GetXMLVersionVTLB |
XML-schemaversie op een datum |
|
POST GetParameterwaarde |
Waarde van één parameter op een datum |
|
POST GetLeeftijd / GetLeeftijdLaatsteDagVorigKwartaal |
Hulpfuncties voor leeftijd |
|
POST GetVergoedingVrachtwagenchauffeurs |
Vergoeding op een datum |
Statuscodes
- 200: gelukt.
- 422: de berekening is uitgevoerd, maar er zijn inhoudelijke fouten of waarschuwingen. De envelop is wel gevuld; zie message en data. Behandel 422 dus niet als technische fout.
- 400: de request is ongeldig of de key ontbreekt. Je krijgt dan ProblemDetails terug.
- 500: serverfout, met ProblemDetails.
Resultaat van een berekening
- data.pdf: PDF-rapport, base64-gecodeerd.
- data.xml: resultaat als XML-string.
- data.bvvPortaalmeldingenSchuldenaar / data.bvvPortaalmeldingenPartner: BVV-portaalmeldingen.
- Schuldenaar en Partner zijn altijd verplicht. Stuur Partner ook mee als er geen partner is.
Snelle test
curl -H "X-Vtlb-Subscription-Key: <key>" https://www.vtlb.rvr.org/v51/api/VTLBApp/GetVersieRecord
'Oude' vtlb-calculator
De ‘oude’ vtlb-calculator (de .exe) en de plug-in worden nog aangeboden tot 1 januari 2027.