Aan de slag

Idempotency

Met een Idempotency-Key kan je een verzoek veilig opnieuw sturen, bijvoorbeeld na een time-out, zonder dat er iets dubbel gebeurt.

GebruikLink naar deze sectie

Stuur bij een POST de header Idempotency-Key mee met een unieke waarde, bijvoorbeeld een UUID. Stuur je binnen 24 uur hetzelfde verzoek met dezelfde sleutel, dan krijg je hetzelfde antwoord terug zonder dat er iets dubbel aangemaakt of verstuurd wordt.

http
Idempotency-Key: 3f1e8c2a-7b4d-4e0a-9c55-1a2b3c4d5e6f

Een herhaald antwoord herken je aan de header Idempotent-Replayed: true.

RegelsLink naar deze sectie

  • Werkt bij alle POST-endpoints. GET en PATCH hebben het niet nodig.
  • Een sleutel hoort bij één API-sleutel en is 24 uur geldig.
  • Maximaal 255 tekens.
  • Dezelfde sleutel met een ander pad of een andere body geeft 422.
  • Loopt het eerste verzoek nog, dan krijg je 409. Probeer het even later opnieuw.
  • Antwoorden met 5xx worden niet bewaard: dan mag je gewoon opnieuw proberen.