Using the API keys

To use the api keys for gemeente amsterdam APIs, the first step is to obtain a key using the online form.

When accessing the APIs, every http request needs to use an X-Api-Key request header that has the value of the api key that has been obtained by filling out the form mentioned above.

Geotools that are using the WFS endpoints are not always able to use an http request header. So, it is also possible to use a query parameter x-api-key with the api key.
However, if possible, use an http request header, because that is less error-prone.

Example using curl for a REST API call with the API key: curl -H "X-Api-Key: very...long...token".

NB. The API Key is only being used to register the useage of our APIs. It does not provide any authentication or authorizations to the APIs.