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 Verblijfplaatshistorie lokaal of in de demo omgeving
Download en lees het onboardingproces

Functionaliteit en specificaties

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

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

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

De functionele documentatie van de BRP API Verblijfplaatshistorie vind je in het features overzicht.

Probeer en test de API in de demo omgeving

Je kunt de BRP API Verblijfplaatshistorie 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.

Bijvoorbeeld met de volgende aanroep, waarbij je de waarde “••••••” bij header x-api-key vervangt met de api key die je ontvangen hebt:

curl --location 'https://demo-omgeving.haalcentraal.nl/haalcentraal/api/brphistorie/verblijfplaatshistorie' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: ••••••' \
--data '{
  "burgerservicenummer": "999994669",
  "type": "RaadpleegMetPeildatum",
  "peildatum": "2020-07-01"
}

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 Verblijfplaatshistorie

Gebruik Docker als container engine

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

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

curl --location --request POST 'http://localhost:5000/haalcentraal/api/brp/verblijfplaatshistorie' \
--header 'Content-Type: application/json' \
--data-raw '{
    "burgerservicenummer": "999994669",
    "type": "RaadpleegMetPeildatum",
    "peildatum": "2020-07-01"
}'

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