API's met de data van data.overheid.nl

De metadata die data.overheid.nl verzamelt in de vorm van datasets, dataverzoeken e.a. is natuurlijk ook te downloaden en herbruikbaar. Hier vind je informatie over gebruik van de API's.

Data.overheid.nl heeft twee soorten API's om informatie te downloaden en hergebruik:

• de datasets API voor informatie over datasets en databronnen die conform de DCAT standaard informatie oplevert;

• de content API voor de informatie van dataverzoeken, toepassingen, organisaties en meer soorten content op data.overheid.nl. Deze content is niet conform een standaard vormgegeven; de API is voor alle data wel gestandaardiseerd in een standaard JSON-query-url.

Datasets API

Voor data.overheid.nl is een API beschikbaar die de metadata van alle aanwezige datasets beschikbaar stelt. Alle informatie op data.overheid.nl is her te gebruiken onder de CC-0 licentie.

De API is te raadplegen via

https://data.overheid.nl/data/api/3/

Voor deze API is uitgebreide documentatie beschikbaar op de CKAN website: https://docs.ckan.org/en/latest/api/index.html inclusief voorbeeld van queries.

Open API specificatie

LET OP: de CKAN API v3 is niet volledig REST API. Er is ook nog geen volledige Open API specificatie voor de CKAN API. Lees meer hierover hier: https://medium.com/apinf/mvp-openapi-spec-for-ckan-api-lessons-learned-268171b00af8

Doel van de API

Met behulp van deze API kunnen organisaties een eigen toegang op het register ontwikkelen, zonder een kopie van de gegevens te hoeven maken. Het dataset register op data.overheid.nl blijft op deze manier het centrale register voor datasets van de hele Nederlandse overheid.

Gebruik van de api

De api van data.overheid.nl is te benaderen via

data.overheid.nl/data/api/3/action/{actie}

waarbij {actie} kan worden vervangen door een gewenste functienaam.

Voorbeelden van requests

Hieronder staan enkele voorbeelden van requests. De resultaten worden teruggegeven in JSON. Raadpleeg voor een volledige omschrijving van alle mogelijkheden de documentatie op CKAN.org.

Alle datasets in de database:

https://data.overheid.nl/data/api/3/action/package_list

Alle informatie over de datasets in de databaase met een limiet van de eerste 10 datasets:

https://data.overheid.nl/data/api/3/action/package_search?start=0&rows=10

Zoeken met een zoekwoord:

https://data.overheid.nl/data/api/3/action/package_search?q=transport

Tips en tricks voor gebruik van de API

• In de API wordt waar mogelijk gebruik gemaakt van URI's voor waarden in metadatavelden. Deze URI's verwijzen naar waardelijsten. Waardelijsten zijn onder andere te vinden in lijstoverzicht.

• de volledige "mapping" van de velden in de API op DCAT, NGR en de veldlabels in de interface van data.overheid.nl is te vinden onder "standaarden en techniek".

• In veel gevallen wordt de "displayname" van de URI als een apart veld toegevoegd in de resultaten vanuit de API. De displayname kan in sommige gevallen niet up-to-date zijn met de waardelijst omdat deze alleen bij het uitvoeren van een import van de externe data-catalogi wordt bijgewerkt.

Andere data op data.overheid.nl: de content API

Naast datasets zijn ook de andere objecten in data.overheid.nl via een API opvraagbaar. Onderstaand is per object de API en een voorbeeld query opgenomen. Er zijn API's voor:

1. dataverzoeken

2. toepassingen

3. organisaties

4. groepen

5. communities

Dataverzoeken

Dataverzoeken zijn te vinden op: https://data.overheid.nl/community/dataverzoeken. Dit is de pagina waarop de dataverzoeken kunnen worden geraadpleegd door bezoekers van de site. Dezelfde informatie is via de JSON-query op te vragen.

https://data.overheid.nl/json/api/1/action/datarequest_search

Deze query levert alle dataverzoeken in JSON formaat. Door een argument toe te voegen aan de URL kan een specifieke subset van de dataverzoeken worden opgevraagd. Voorbeeld:

https://data.overheid.nl/json/api/1/action/datarequest_search?search=scheepvaart

Uit de zoekresultaten kan vervolgens een individueel objecten worden opgevraagd met de ID:

https://data.overheid.nl/json/api/1/action/datarequest_show?id=1762

Deze informatie is ook opgenomen als dataset in data.overheid.nl. De dataset: https://data.overheid.nl/dataset/dataverzoeken-data-overheid-nl.

Toepassingen

Toepassingen zijn te vinden op: https://data.overheid.nl/community/toepassingen. Dit is de pagina waarop de toepassingen kunnen worden geraadpleegd door bezoekers van de site. Dezelfde informatie is via de JSON-query op te vragen.

https://data.overheid.nl/json/api/1/action/application_search

Deze query levert alle dataverzoeken in JSON formaat. Door een argument toe te voegen aan de URL kan een specifieke subset van de dataverzoeken worden opgevraagd. Voorbeeld:

https://data.overheid.nl/json/api/1/action/application_search?search=scheepvaart

Uit de zoekresultaten kan vervolgens een individueel objecten worden opgevraagd met de ID:

https://data.overheid.nl/json/api/1/action/application_show?id=4405

Deze informatie is ook opgenomen als dataset in data.overheid.nl. De dataset: https://data.overheid.nl/dataset/toepassingen-data-overheid-nl.

Organisaties

Organisaties (data-eigenaren en toepassingen makers) zijn te vinden op: https://data.overheid.nl/community/organisaties. Dit is de pagina waarop de organisaties kunnen worden geraadpleegd door bezoekers van de site. Dezelfde informatie is via de JSON-query op te vragen.

https://data.overheid.nl/json/api/1/action/organization_search

Deze query levert alle dataverzoeken in JSON formaat. Door een argument toe te voegen aan de URL kan een specifieke subset van de dataverzoeken worden opgevraagd. Voorbeeld:

https://data.overheid.nl/json/api/1/action/organization_search?search=utrecht

Uit de zoekresultaten kan vervolgens een individueel objecten worden opgevraagd met de ID:

https://data.overheid.nl/json/api/1/action/organization_show?id=2234

Deze informatie is ook opgenomen als dataset in data.overheid.nl. De dataset: https://data.overheid.nl/dataset/organisaties-data-overheid-nl.

Groepen

Groepen zijn te vinden op: https://data.overheid.nl/community/organisaties. Dit is de pagina waarop de groepen kunnen worden geraadpleegd door bezoekers van de site. Dezelfde informatie is via de JSON-query op te vragen.

https://data.overheid.nl/json/api/1/action/group_search

Deze query levert alle dataverzoeken in JSON formaat. Door een argument toe te voegen aan de URL kan een specifieke subset van de dataverzoeken worden opgevraagd. Voorbeeld:

https://data.overheid.nl/json/api/1/action/group_search?search=onderwijs

Uit de zoekresultaten kan vervolgens een individueel objecten worden opgevraagd met de ID:

https://data.overheid.nl/json/api/1/action/group_show?id=3517

Deze informatie is ook opgenomen als dataset in data.overheid.nl. De dataset: https://data.overheid.nl/dataset/groepen-data-overheid-nl.

Communities

Communities zijn te vinden op: https://data.overheid.nl/search/communities. Dit is de pagina waarop de communities kunnen worden geraadpleegd door bezoekers van de site. Dezelfde informatie is via de JSON-query op te vragen.

https://data.overheid.nl/json/api/1/action/community_search

Deze query levert alle dataverzoeken in JSON formaat. Door een argument toe te voegen aan de URL kan een specifieke subset van de dataverzoeken worden opgevraagd. Voorbeeld:

https://data.overheid.nl/json/api/1/action/community_search?search=onderwijs

Uit de zoekresultaten kan vervolgens een individueel objecten worden opgevraagd met de ID:

https://data.overheid.nl/json/api/1/action/community_show?id=3470

Deze informatie is ook opgenomen als dataset in data.overheid.nl. De dataset: https://data.overheid.nl/dataset/groepen-data-overheid-nl.