Getting Started

Gemeenten en andere organisaties met een autorisatiebesluit kunnen zich aanmelden voor deelname aan het Experiment dataminimalisatie.

Bekijk de functionaliteit en specificaties
Probeer en test de BRP API Bewoning lokaal of in de demo omgeving
Download en lees het onboardingproces

Functionaliteit en specificaties

De BRP API Bewoning is gespecificeerd met behulp van de OpenAPI Specification v3.0.3.

De OAS3 specificatie van de BRP API Bewoning kan worden bekeken met behulp van Redoc.

Download de OAS3 specificatie van de ‘BRP API Bewoning’ om hiermee consumer code te genereren.

De functionele documentatie van de ‘BRP API Bewoning’ vind je in de features overzicht.

Probeer en test de API in de demo omgeving

Je kunt de BRP API Bewoning uitproberen op de demo omgeving met de volgende url: [https://demo-omgeving.haalcentraal.nl]. Hiervoor heb je een apikey nodig.

Vraag een apikey aan bij de product owner cathy.dingemanse@rvig.nl.
Voeg de apikey toe aan een request met de X-API-KEY header.

Probeer en test de API lokaal

Een mock van de BRP API Bewoning 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 Bewoning mock met behulp van Docker Desktop te draaien op een lokale machine.

In het docker compose bestand is een volume map geconfigureerd naar de ./src/config/BewoningService map met het test-data.json bestand. Dit bestand bevat verblijfplaatsgegevens van persoonslijsten die voorkomen in de LAP omgeving en kan worden uitgebreid met eigen test verblijfplaatsgegevens. Herstart de container als het test-data.json bestand is gewijzigd. Aangezien dit bestand kan worden bijgewerkt, is het handig om wijzigingen aan het einde van het bestand toe te voegen. Dit maakt het makkelijker om eigen wijzigingen veilig te stellen voordat het bestand lokaal moet worden bijgewerkt.

In plaats van het docker compose bestand kun je de Kubernetes configuratie bestanden gebruiken om de BRP API Bewoning mock te draaien op een lokale machine. De BRP API Bewoning 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 Bewoning mock op een lokale machine te installeren en aan te roepen.

Prerequisites

Docker Desktop voor het hosten van containers
Je kunt Docker Desktop ook gebruiken om de containers te hosten met behulp van de Kubernetes engine. Hiervoor moet je in Docker Desktop Kubernetes ondersteuning aanzetten in het Settings/Kubernetes configuratie scherm

Optioneel kun je de volgende tools ook op de lokale machine installeren:

git voor het clonen van git repositories
Postman voor het aanroepen van BRP API Bewoning

Gebruik Docker als container engine

Download het docker compose bestand
Start een command prompt window voor de map met het docker-compose-mock.yaml bestand
Start de BRP API Bewoning mock met behulp van de volgende statement:
```
docker-compose -f docker-compose-mock.yml up -d
```
De BRP API Bewoning mock is nu te benaderen via de url: http://localhost:5010/haalcentraal/api/bewoning/bewoningen

Valideer dat de BRP API Bewoning mock draait met behulp van de volgende curl statement:

curl --request POST \
--url 'http://localhost:5010/haalcentraal/api/bewoning/bewoningen' \
--header 'Content-Type: application/json' \
--data '{
  "type": "BewoningMetPeildatum",
  "adresseerbaarObjectIdentificatie": "0599010000208579",
  "peildatum": "2015-08-08"
}'

Om de BRP API Bewoning mock container te stoppen voer je de volgende statement uit:
```
docker-compose -f docker-compose-mock.yml down
```

Gebruik Kubernetes als container engine

Download de kubernetes configuratie bestanden
Start een command prompt window voor de map met de kubernetes manifest bestanden
Start de BRP API Bewoning mock met behulp van de volgende statement:
```
kubectl apply -f .k8s/bewoningenmock-deployment.yaml \
              -f .k8s/bewoningenmock-service.yaml 
```
De BRP API Bewoning mock is nu te benaderen via de url: http://localhost:5010/haalcentraal/api/bewoning/bewoningen

Valideer dat de BRP API Bewoning mock draait met behulp van de volgende curl statement:

curl --request POST \
--url 'http://localhost:5010/haalcentraal/api/bewoning/bewoningen' \
--header 'Content-Type: application/json' \
--data '{
  "type": "BewoningMetPeildatum",
  "adresseerbaarObjectIdentificatie": "0599010000208579",
  "peildatum": "2015-08-08"
}'

Om de BRP API Bewoning mock container te stoppen voer je de volgende statement uit:

kubectl delete -f .k8s/bewoningenmock-deployment.yaml \
               -f .k8s/bewoningenmock-service.yaml 