...
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.We verwijzen voor deze vraag door naar volgende pagina: Idempotentie API
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.
...