API Richtlijnen

Op deze pagina worden richtlijnen en best practices beschreven die gevolgd moeten worden bij het ontwikkelen van de integratie met de API.

Algemene standaarden

Meesturen User-Agent header

We verwachten dat de User-Agent header met elke API-aanvraag wordt meegestuurd. Deze header moet voldoen aan de specificatie zoals beschreven in RFC 9110.

De User-Agent header bevat informatie over welk systeem de aanvraag heeft gedaan en kan gebruikt worden voor rapportering of bij het troubleshooten van integratieproblemen tussen beide systemen.

Voorbeelden

• ReactorNetty/1.1.19

• Apache-HttpClient/4.5.2

• HttpClient/1.0

Idempotentie

Meer informatie is te vinden op Idempotentie.

Concurrency

Meer informatie is te vinden op Concurrency.

Correlatie en Tracing

Meer informatie is te vinden op Correlatie en Tracing.