Introductie

Wat is een API-key en hoe werkt het?

Stel je een API voor als een beveiligde digitale deur naar een applicatie of dienst die bepaalde informatie of functies toegankelijk maakt.
Net zoals een deur een sleutel nodig heeft om geopend te worden, heeft deze API een API-key nodig om toegang te geven tot informatie die niet publiek is.
Een API-key is letterlijk een code (vaak een reeks van willekeurige letters en cijfers) waarmee u als gebruiker (of een applicatie/toepassing) zich identificeert en toegang krijgt om data via de API op te vragen.
Met een API-key die op deze site kan worden aangemaakt, kunt u observaties en gerelateerde data ophalen voor de organisaties waar u toegang heeft gekregen, volgens de Digitale Delta standaard 'DD API V3'. Deze geeft toegang tot data die de waterbeheerders in AquaDesk hebben opgeslagen. AquaDesk is een beheersysteem voor metingen en wordt gebruikt door diverse waterbeheerders en laboratoria. Via deze link kunt u met uw API-key toegang krijgen tot de data.
Hoe u gebruik kunt maken van de API kunt u hier lezen.
Het vereist echter wel enige kennis van het algemene gebruik van API's en het gebruik van zogenaamde 'headers'.

Toegang verkrijgen

De API-key op zichzelf geeft beperkte tot de data van de organisaties:

Organisatie Soort data
Historische data Provincie Noord Holland Ecologisch, fysisch, chemisch
Publieke data van Rijkswaterstaat Ecologisch
Publieke data van Hoogheemraadschap Hollands Noorderkwartier Ecologisch, fysisch, chemisch

Voor andere data heeft u rechten nodig van andere waterbeheerders.
De e-mailadressen daarvoor kunt u terugvinden op deze pagina nadat u een API-Key heeft aangevraagd.

Aanvragen

Een API-key voor kunt u hier aanvragen.