Omgevingsdocument opvragen (REST API) - Feedback

Organisaties Digitaal Stelsel Omgevingswet
#1

Laat hier je feedback op de Omgevingsdocument opvragen API achter.

Met deze API worden alle omgevingsdocumenten ontsloten die door overheden beschikbaar zijn gesteld aan de Landelijke Voorziening Bekendmaken en Beschikbaar stellen (LVBB). Het betreft alle gegevens waar het omgevingsdocument uit is opgebouwd. De gegevens worden objectgericht ontsloten op basis van de API strategie van het Digitaal Stelsel Omgevingswet.

De API Omgevingsdocument opvragen vind je in het API-register.

#2

Goeiemiddag,

Via Postman lukt het goed om requests naar de ROD API te sturen en data terug te krijgen.
Maar graag zou ik vanuit de browser met behulp van javascript ook een request willen doen op de API en data terug krijgen.
Als ik de x-api-key header meestuur krijg ik de melding dat de header niet is toegestaan (Acces-Control -Allow-Headers). Als ik de api key weglaat, krijg ik de melding unauthorized.
Hieronder een stukje van de code:

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://service.pre.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/opvragen/v1/regelingen",
  "method": "GET",
  "headers": {
   "X-Api-Key": "{api key}",
   "Accept": "application/hal+json"
  }
}
$.ajax(settings).done(function (data) {
  console.log(data);
});

Wat zie ik over het hoofd of hoe kan ik wel vanuit de browser met javascript een request naar de ROD API sturen?
Alvast bedankt voor de reactie!

#3

Ik heb je vraag neergelegd bij het team dat verantwoordelijk is voor deze API.

1 like
#4

Hallo, excuses voor het slome antwoord. Het duurde even voor ik er achter was dat dit forum ook al echt actief was. Ik heb bovenstaande even neergelegd bij ons team. Daar komt het volgende antwoord uit:
Deze vraag hoort bij het Knooppunt. De browser doet een zogenaamde “preflight” request (HTTP OPTIONS) voordat het daadwerkelijke GET-request wordt uitgevoerd (HTTP GET). De reden hiervoor is om CORS headers af te stemmen (Cross-Origin Resource Sharing (CORS) - HTTP | MDN). Met Chrome krijgen we de foutmelding ‘Request header field X-Api-Key is not allowed by Access-Control-Allow-Headers in preflight response’. Dit betekent dat de custom header ‘X-Api-Key’ niet toegestaan lijkt en dat de browser vervolgens geen GET-request uitvoert. Afhankelijk van de browser is ander gedrag mogelijk.
Overigens zullen we deze casus wel gaan opnemen in een eigen test. We willen graag weten of onze spullen het buiten ook doen.

#5

Deze service is tijdelijk niet beschikbaar!
Binnenkort zal versie 2 van deze service beschikbaar worden gesteld.

#6

Ik probeer omgevingsdocumenten van het type ‘omgevingsplan’ te queryen met de volgende request:

https://service.pre.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/opvragen/v2/documenten?document.type=omgevingsverordening

Echter krijg ik dezelfde response als wanneer ik een request zonder query parameters invoer. Doe ik hier iets verkeerd?

#7

Ik krijg de volgende quota-melding, zonder ‘rare’ dingen te doen. Dwz, slechts een serie van enkele requests voor 2 percelen binnen een enkel plan. Dit heb ik binnen het tijdsbestek van een kwartier hooguit een keer of 5 gedaan.

{“fault”:{“code”:900804,“message”:“Message throttled out”,“description”:“You have exceeded your quota”,“nextAccessTime”:“2023-Nov-26 12:31:40+0000 UTC”}}

Ik lees in de beschrijving alleen: “Voor deze API geldt een bevragingslimiet van 200 per seconde”.
Hier kom ik bij lange na niet aan.

Wat zijn de precieze limieten voor zo’n melding verschijnt? En zijn er meer dan de genoemde limiet van 200 bevragingen per seconde?

Bij voorbaat dank voor een reactie.
Toevoeging: deze bevinding heeft betrekking op de presenteren api, ipv de opvragen api (maar ik werd via de link op de pagina van deze presenteren api doorgestuurd naar dit forum-onderwerp).

#8

Ik heb even navraag voor je gedaan bij het team dat de bevragingslimieten afdwingt/controleert. Er zit een klein foutje in het afdwingen van de bevragingslimiet. Komende maandag is er een release die dit zou moeten verhelpen. Mocht het probleem daarna alsnog bestaan, kan een nieuwe API key aangevraagd worden.

1 like