Ga naar inhoud
Developer Documentation

Changelog

Deze pagina beschrijft wijzigingen aan het publieke contract van de Avallo REST API.

Zie Versiebeheer voor het versiebeleid en de betekenis van MAJOR.MINOR.PATCH.

Eerste publieke versie van de Avallo REST API.

  • Authenticatie met een afnemerspecifieke API-key via X-API-Key.
  • Discovery van beschikbare grondwatermonitoringputten en peilbuizen via GET /v1/groundwater-monitoring-wells.
  • Stabiele identificatie van een peilbuis via tubeIdentifier.
  • Ophalen van een GroundwaterLevelSeries via GET /v1/groundwater-monitoring-tubes/{tubeIdentifier}/measurements.
  • Verplichte tijdsbegrenzing met inclusief from en exclusief to, met een maximaal interval van 366 dagen.
  • Normalisatie van datum- en tijdwaarden naar UTC.
  • Vermelding van meeteenheid en verticaal referentiestelsel via unit en verticalDatum.
  • Autorisatie op peilbuisniveau, waarbij niet-toegankelijke peilbuizen niet via discovery worden gepubliceerd.
  • Problem Details-responses via application/problem+json.
  • De responseheader API-Version.
  • Rate limiting van 30 requests per minuut, een burstcapaciteit van 60 requests en maximaal 2 gelijktijdige requests per API-client.
  • Een publiek OpenAPI 3.1.1-contract via /v1/openapi.json.
  • Geautomatiseerde conformance-tests en Spectral-linting tegen de NLGov REST API Design Rules 2.2.0.