Getting Started
De ‘Bevraging Ingeschreven Persoon’ Web API is gespecificeerd in OpenAPI specifications (OAS).
Wil je de API gebruiken? Dit kun je doen:
- Bekijk de functionaliteit en specificaties
- Implementeer de API
- Probeer en test de API
Functionaliteit en specificaties
Je kunt een visuele representatie van de specificatie genereren met Swagger UI of Redoc.
De (resolved) OAS3 kun je hier downloaden: openapi.yaml.
De functionele documentatie vind je in features.
Implementeer de API
Je kunt code genereren op basis van de genereervariant van de specificaties. Voor enkele ontwikkelomgevingen is al client code gegenereerd.
Probeer en test
Wil je de ‘Bevraging Ingeschreven Persoon’ Web API proberen en testen? Kijk op: https://www.haalcentraal.nl/haalcentraal/api/brp
Om de web api te gebruiken heb je een apikey nodig. Deze voeg je aan een request toe als header “X-API-KEY”. Een API-key vraag je aan bij de product owner cathy.dingemanse@denhaag.nl.
De Haal Centraal probeeromgeving gebruikt GBA-V op basis van de gemeentelijke autorisatie “Algemene gemeentetaken” voor buitengemeentelijke personen. Dit betekent dat de GBA-V niet alle gegevens teruggeeft die in de response zijn gedefinieerd. In de API mapping kun je zien welke gegevens wel of niet onder deze autorisatie vallen.
Je kan de Haal Centraal probeeromgeving niet gebruiken vanuit de browser, dus ook niet vanuit de browserversie van Postman. Gebruik dus de desktopversie van een testtool (zoals Postman) om berichten te sturen.
Importeer de specificaties in Postman
De werking van de ‘Bevraging Ingeschreven Persoon’ Web API is het makkelijkst te testen met behulp van Postman. We hebben al een Postman collection voor je klaargezet. Deze kun je importeren in Postman.
In Postman kun je de ‘Bevraging Ingeschreven Persoon’ OpenAPI specificatie importeren en visueel de verschillende endpoints aanroepen. Volg deze stappen om het OpenAPI specificatie bestand te importeren:
1.Klik op de Import button om de Import dialog box te openen
2.Selecteer ‘Import From Link’ tab, plak de volgende url in de ‘Enter a URL and press Import’ textbox en klik op de Import button
https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/master/specificatie/genereervariant/openapi.yaml
3.Klik op de Next button om een Postman collectie te genereren uit het OpenAPI specificatie bestand
4.Import overzicht
Configureer de url en api key
- Klik bij “Bevragingen Ingeschreven Personen” op de drie bolletjes.
- Klik vervolgens op Edit
- Selecteer tabblad “Authorization”
- Kies TYPE “API Key”
- Vul in Key: “x-api-key”, Value: de API key die je van Cathy hebt ontvangen, Add to: “Header”
- Selecteer tabblad “Variables”
- Vul bij baseUrl INITIAL VALUE en bij CURRENT VALUE:
https://www.haalcentraal.nl/haalcentraal/api/brp - Klik op de knop Update
Raadpleeg een Ingeschreven Natuurlijk Persoon
Selecteer hiervoor de /GET ingeschreven Natuurlijk Persoon request.
In het rechterscherm zie je een invoerscherm voor de request. Uncheck voor de volgende voorbeeldaanroep de expand en fields Query Params en vul in de burgerservicenummer Path Variabele een bsn in (zie onderaan de Getting started voor mogelijke burgerservicenummers).
Klik op de Send button om de request naar de endpoint te sturen. De Web API reageert dan met een response:
De Web API gebruikt de HAL (Hypertext Application Language) standaard om links op te nemen naar gerelateerde resources en/of om bij een resource gerelateerde resources op te nemen (embedden).
In de response hierboven kun je zien dat het _links/ouders element links bevat naar de ouders van de persoon.
Je kunt ook oudergegevens embedden bij het bevragen van een persoon. Dit doe je met de expand Query Parameter. Behalve de ouders kun je ook kind(-eren) en partner(s) in de bevraging van een ingeschreven persoon embedden. Deze gegevens zijn te vinden onder de _embedded element:
In dit figuur zie je hoe de expand Query Parameter eruit moet zien om de ouders, kinderen en partner te embedden in de response van een ingeschreven persoon.
Je kunt ook alleen specifieke kenmerken van een ingeschreven persoon opvragen met behulp van de fields Query Parameter. Hieronder zie je een bevraging met de fields Query Parameter gezet op burgerservicenummer,naam,geboorte.datum.
Testpersonen
Deze tabel bevat de burgerservicenummers van testpersonen voor specifieke situaties waarmee de ‘Bevraging Ingeschreven Persoon’ Web API kan worden getest.
| burgerservicenummer | situatie |
|---|---|
| 999993847 | ouders, partner, kinderen, BAG-adres, verblijfplaats in onderzoek |
| 999992077 | overleden |
| 999993483 | geëmigreerd, verblijf buitenland, geheimhouding, uitgebreide verblijfplaatshistorie |
| 999990482 | niet-BAG adres |
| 000009921 | locatiebeschrijving |
| 999993653 | niet-Nederlandse nationaliteit, ouders niet ingeschreven |
| 999995017 | actuele en historische verblijfstitel |
| 999990408 | gezag minderjarige |
| 999994669 | verblijfplaatshistorie met verblijf buitenland en locatiebeschrijving en adrescorrectie |
| 999992806 | uitgebreide verblijfstitelhistorie |
| 999993926 | actuele en meerdere ex-partners |
| 999991905 | twee beëindigde relaties |
| 999993550 | partner niet ingeschreven |
| 999990421 | meerdere kinderen, wel en niet-ingeschreven |
De API gebruikt de GBA-V proefomgeving. Alle testpersonen die daarin voorkomen kun je ook in de API gebruiken. De volledige set testpersonen kan worden gedownload bij de RvIG. Een vertaling van GBA-V (LO GBA) attributen naar BRP API properties staat beschreven in de BRP-LO GBA mapping.