topic Re: Help Needed: Accessing API in Data Pipelines Questions

Help Needed: Accessing API

IB3 — Tue, 08 Jul 2025 16:28:17 GMT

Hi,

I'm new to data pipelines and could really use some guidance with the Omgevingswet API. I'm trying to access the API from https://developer.omgevingswet.overheid.nl/api-register/api/rp-opvragen/ using a 32-character API key I just received.

I attempted to get data using a direct URL, but I encountered a 401 Unauthorized error. This suggests I might not be passing the parameters correctly, specifically how to include my API key for authentication.

Could someone please help me understand how to properly structure my request to access the data from this API? Once I can retrieve the data, I'm also looking for advice on how to visualize the geometries it contains.

I know this might be a simple fix, but I'm just starting out!

Thanks!

Any help would be greatly appreciated!

Thanks,

Re: Help Needed: Accessing API

MaxPayson — Wed, 09 Jul 2025 04:49:50 GMT

Hi @IB3 , from the Open API specification in the documentation you linked, it looks like the API key needs to be included in a header named "X-Api-Key". You can do this by following the documentation here, and specifying the following parameters for the service connection:

Authentication type: API key
Parameter location: Header
Parameter name: X-Api-Key

Then for the geometries, do you know what the data schema is, or could you provide an example? It looks like the response format is JSON and I'm wondering what specific fields and data types that JSON contains. You can get the full schema by adding the URL input, clicking "Preview", then clicking "Schema", then clicking "Expand all". There's a clip of this in the release blog under the "Enhanced schema preview" section.