Overheidsorganisaties ontwikkelen veel API’s om allerlei data snel en efficient te delen met andere overheidsorganisaties en andere partijen die met de overheid werken. In deze post leer je hoe je zelf deze API’s kan gebruiken.
Proces
1. Vind een API met de data die je nodig hebt
Voor dat je een API gaat zoeken, bepaal eerst welk probleem je probeert op te lossen en hoe bepaalde overheids data hier mee kan helpen. Vind dan een API die de gegevens levert die je nodig hebt. In ons API register vind je een hoop API’s van de overheid. Heb je een API gevonden, klik dan op de API specificatie om precies te zien wat deze API allemaal kan leveren.
2. Krijg toegang tot de API
Op een API detailpagina kan je zien hoe je toegang kan krijgen:
- Kijk eerst naar
Gebruik: als niet iedereen de API kan gebruiken dan moet je contact opnemen met de organisatie om toestemming te vragen. - Als de API
Kostenheeft, moet je kosten betalen om de API te gebruiken. Bij deDocumentatievan de API vind je hier meer informatie over. - Als de API
Authenticatievereist, moet je eerst een aanvraag maken voor een API authenticatie token die jou toegang geeft tot de API. Deze informatie kan je ook vinden bij de APIDocumentatie.
3. Gebruik de API
Nu kan je de API gaan gebruiken!
- Op de API pagina vind je de URL van de verschillende omgevingen van de API. Gebruik de URL van de productie omgeving, omdat dat de meest betrouwbare is. Probeer vanaf je code een request te maken naar deze URL en check of de API werkt. De API werkt als je een HTTP response krijgt met een HTTP 200 OK status code.
- Lees de
Specificatieom te leren hoe je de data kan krijgen die je nodig hebt. - Maak requests als bescheven in de specificatie om de data te gebruiken in je applicatie.
Voorbeeld
Voor een voorbeeld, zie de API pagina van CBS Cijfers Open Data, en zie Codevoorbeelden van het gebruik van CBS Open Data v4 in R en Python..
Feedback
Je kan op elke API feedback geven! Om feedback te geven op een API klik je op Naar community topic op de detailpagina van de API.