Gemeenten en andere organisaties met een autorisatiebesluit kunnen zich aanmelden voor deelname aan het Experiment dataminimalisatie.
De BRP API Personen is gespecificeerd met behulp van de OpenAPI Specification v3.0.3.
De OAS3 specificatie van de BRP API Personen kan worden bekeken met behulp van Redoc.
Download de OAS3 specificatie van de ‘BRP API Personen’ om hiermee consumer code te genereren.
De functionele documentatie van de BRP API Personen vind je in het features overzicht.
Je kunt de BRP API Personen uitproberen op de proefomgeving met de volgende url: [https://proefomgeving.haalcentraal.nl]. Hiervoor heb je een apikey nodig.
Een mock van de BRP API Personen is beschikbaar als een containerized applicatie, die je gemakkelijk kunt hosten op een lokale machine of in een testomgeving. Bijkomend voordeel is dat je je eigen testgevallen kunt toevoegen aan het JSON bestand.
Je kunt het docker compose bestand gebruiken om de BRP API Personen mock met behulp van Docker Desktop te draaien op een lokale machine.
In plaats van het docker compose bestand kun je de Kubernetes configuratie bestanden gebruiken om de BRP API Personen mock te draaien op een lokale machine. De BRP API Personen mock maakt gebruik van de testdataset persoonslijsten proefomgevingen GBA-V als input om de productie situatie zoveel mogelijk te kunnen simuleren.
De volgende paragrafen beschrijven wat je moet doen om de BRP API Personen mock op een lokale machine te installeren en aan te roepen.
Optioneel kun je de volgende tools ook op de lokale machine installeren:
docker-compose -f docker-compose-mock.yml up -d
De BRP API Personen mock is nu te benaderen via de url: http://localhost:5001/haalcentraal/api/brp/personen
curl --location --request POST 'http://localhost:5001/haalcentraal/api/brp/personen' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "RaadpleegMetBurgerservicenummer",
"burgerservicenummer": ["999993653"],
"fields": ["burgerservicenummer"]
}'
docker-compose -f docker-compose-mock.yml down
kubectl apply -f .k8s/brppersonenmock-deployment.yaml \
-f .k8s/brppersonenmock-service.yaml
De BRP API Personen mock is nu te benaderen via de url: http://localhost:5001/haalcentraal/api/brp/personen
curl --location --request POST 'http://localhost:5001/haalcentraal/api/brp/personen' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "RaadpleegMetBurgerservicenummer",
"burgerservicenummer": ["999993653"],
"fields": ["burgerservicenummer"]
}'
kubectl delete -f .k8s/brppersonenmock-deployment.yaml \
-f .k8s/brppersonenmock-service.yaml