Aan de slag

Als ontwikkelaar kunt je direct aan de slag:

  1. Bekijk de functionaliteit en specificaties

  2. Download de OpenAPI specificaties en JSON schemas

  3. Bouw de aansluiting op de BRP Berichten API en test middels de DEMO-omgeving.

  4. Sluit aan op de proefomgeving en doorloop de acceptatietesten (schouwen en toetsen). Je bent klaar voor productie!

Stap 1 - Bekijk de functionaliteit en specificaties

De OpenAPI specificatie van deze API is opgenomen in de repository en is tevens als grafische representatie in te zien middels redocly. Hier zijn ook de JSON-schemas opgenomen die duiden hoe de berichten en de inhoud van deze berichten er uit dienen te zien.

Middels het Logisch Ontwerp BRP kun je meer context vergaren met betrekking tot hoe deze berichten gebruikt worden en welke berichtcycli daarbij betrokken zijn.

Tot slot zijn veel berichten gerelateerd aan persoonslijsten. Ook deze worden uitgedrukt middels een JSON-structuur welke zich conformeert aan het Logisch Ontwerp BRP. Hoe deze opgebouwd zijn wordt toegelicht middels:

Stap 2 - Download de OpenAPI specificaties

Download de specificaties en de bijbehorende JSON-schemas.

Stap 3 - Bouw de aansluiting op de BRP Berichten API en test middels de DEMO-omgeving.

Om te integreren met de BRP Berichten API zul je een client moeten realiseren. Om je in een vroeg stadium bekend te laten raken met de BRP Berichten API is er een demo-omgeving ter beschikking gesteld. Dit is een omgeving waarmee je zonder diginetwerk kunt verbinden en zonder consequenties zaken uit kunt proberen. Toegang is daarbij laagdrempelig ingericht, je kunt zelf bepalen namens wie je berichten verstuurd en namens wie je berichten wilt ontvangen. Hiermee raakt je bekend met het koppelvlak en kunt je een client realiseren die compatible is met dit koppelvlak.

Let op: andere partijen die ook toegang hebben tot de demo-omgeving kunnen dezelfde mailbox-accounts kiezen als die jij ook gekozen hebt. Houd er rekening mee dat je NOOIT gevoelige informatie plaatst op de demo-omgeving. Ga ervan uit dat de gegevens die je instuurt ook door anderen ingezien kunnen worden.

  1. Lees hoe het verzenden en ontvangen van berichten werkt zodat je vooraf weet wat je kunt verwachten.

  2. Zorg dat je client zich conformeert aan de OpenAPI specificatie en de JSON-schemas die daarbij betrokken zijn.

  3. Vraag toegang aan tot de demo-omgeving van de BRP Berichten API via info@rvig.nl.

  4. Toets zelf middels de demo-omgeving of je client berichten kan verzenden en ontvangen. Gebruik daarbij eventueel de voorbeeldberichten die hiervoor beschikbaar zijn gesteld.

Als je deze stappen doorlopen hebt, kunt je door naar de volgende stap waarbij je aansluit op de proefomgeving.

Stap 4 - Aansluiten op de proefomgeving

In de proefomgeving sluit je daadwerkelijk aan op een keten, je kan deze omgeving dan ook beschouwen als een ketentestomgeving. Hierbij vindt daadwerkelijk interactie plaats met de BRP(-V). Je authenticeert hier middels je eigen afnemerId en communiceert daarmee met de BRP(-V) net zoals dit in productie zou gebeuren.

Samen met het Test & Deployment Team van RvIG doorloopt je deze fase die uiteindelijk afgerond wordt middels een S&T-test (Schouwen en Toetsen). Daarmee wordt vastgesteld of je software zich conformeert aan de bericht-cycli zoals afgesproken in het Logisch Ontwerp BRP en daarmee in productie genomen mag worden.

Meer informatie over het aansluiten op de proef- en productieomgeving en informatie over de S&T-test staat hier beschreven.