Gebruik
Bij POST calls wordt verwacht dat er een header wordt meegestuurd genaamd idempotency-key . We raden aan om als waarde een UUID v4 mee te geven, maar in principe moet dit gewoon een unieke waarde zijn per call die uitgevoerd wordt.
Wat is een idempotency key?
"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 beschouwt 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.
Meer info over idempotentie is hier terug te vinden.