Home
Terug naar algemene info over VHP
Terug naar overzicht veelgestelde vragen
Overzicht van vragen:
Waarom is een ISO2 code verplicht bij een belanghebbende?
Wij synchroniseren elke belanghebbende met INSZ, KBO, VE of OVO-code uit een authentieke bron en bekomen zo de ISO2 code.
Indien een belanghebbende geen unieke referentienummer heeft om te synchroniseren vragen wij dat de ISO2 code wordt ingevuld. Dit is noodzakelijk om te kunnen kennisgeven.
Kennisgeving gebeurt via de MAGDA Documentendienst dewelke de verzorging hiervan doet via eBox of post. Voor de post is de ISO2 code een vereiste.
Moeten we altijd eerst een GET doen van een belanghebbende?
Indien je een POST doet van een belanghebbende met INSZ/KBO/VE/OVO en wij kennen die INSZ/KBO/VE/OVO, krijg je altijd de UUID van de bestaande belanghebbende terug.
PostBelanghebbende - Vlaams Handhavingsplatform - Confluence (atlassian.net) > Validatie 2.
Dat gezegd zijnde is er helemaal niets mis met altijd eerst een GET te doen.
Wat is een idempotency key en waarom moet ik deze gebruiken?
"An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request."
Deze dient dus om duplicate request te voorkomen. Het VHP gebruikt de idempotency key om het onderscheid te maken tussen een nieuwe request en de retry van een vorige request.
Als de idempotency key nog niet is gebruikt dan wordt de request als nieuw beschouwd en zal de logica achter het endpoint aangeroepen worden.
Als de idempotency key in een vorige request is gebruikt dan zal de originele response teruggegeven worden en zal de logica achter het endpoint niet aangeroepen worden.
De idempotency key moet verschillend zijn per request, we stellen voor dat de aansluiters UUID v4 gebruiken voor het genereren van de key. Enkel als dezelfde request opnieuw word geprobeerd moet dezelfde idempotency key gebruikt worden.
Voorbeeld scenario
De HTTP request faalt omwille van een technisch probleem (bvb een timeout). De client heeft in dit scenario geen succesvolle response ontvangen en heeft geen zekerheid dat de request niet is behandeld door het VHP. Als dezelfde request hierna opnieuw geprobeerd word met een andere idempotency key zal het dossier 2x bestaan.
Hoe kunnen we API toegang verkrijgen?
Het login endpoint in de swagger mag niet door aansluiters gebruikt worden. Voor de API moeten aansluiters een access token verkrijgen bij ACM (https://authenticatie.vlaanderen.be/docs/beveiligen-van-api/oauth-rest/rest-server2server/ ).