Aan de slag

Als ontwikkelaar kun je direct starten met het aansluiten op de BRP Berichten API:

  1. Bekijk de functionaliteit en technische specificaties

  2. Download de OpenAPI-specificaties en de JSON-schema’s

  3. Bouw de aansluiting op de BRP Berichten API en test deze via de demo-omgeving.

  4. Sluit aan op de proefomgeving en doorloop de compliancytesten (Schouwen en Toetsen).

  5. 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 ook als grafische weergave in te zien middels Redocly. Hier zijn ook de JSON-schema’s opgenomen die beschrijven hoe de berichten zijn opgebouwd en welke gegevens deze bevatten.

Middels het Logisch Ontwerp BRP (LO BRP) kun je meer context krijgen over hoe deze berichten worden gebruikt en welke berichtcycli daarbij betrokken zijn.

Veel berichten zijn gerelateerd aan persoonslijsten. Deze zijn opgebouwd volgens een JSON-structuur die aansluit op het LO BRP. De opbouw hiervan wordt toegelicht via:

Stap 2 - Download de OpenAPI specificaties

Download de specificaties en de bijbehorende JSON-schema’s via:

Stap 3 - Bouw de aansluiting op de BRP Berichten API en test deze via de demo-omgeving.

Om te integreren met de BRP Berichten API ontwikkel je een client. Om je in een vroeg stadium bekend te laten raken met de BRP Berichten API is een demo-omgeving beschikbaar. In deze omgeving:

  • Kun je zonder Diginetwerk verbinding maken

  • Kun je zonder gevolgen testen en experimenteren

  • Kun je zelf bepalen namens welke organisaties je berichten verstuurt en ontvangt.

Hiermee raak je bekend met het koppelvlak en kun je jouw client-implementatie stap voor stap ontwikkelen en testen.

Let op: andere organisaties die ook toegang hebben tot de demo-omgeving kunnen dezelfde mailbox-accounts gebruiken als jouw organisatie. Plaats daarom nooit persoonsgegevens of andere gevoelige informatie op de demo-omgeving. Houdt er rekening mee dat de gegevens die je verstuurt ook voor anderen zichtbaar zijn.

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

  2. Zorg dat je client voldoet aan de OpenAPI-specificatie en de JSON-schema’s.

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

  4. Test via de demo-omgeving of je client berichten kan verzenden en ontvangen. Gebruik eventueel de beschikbare voorbeeldberichten.

Heb je deze stappen afgerond? Dan kun je verder met aansluiten op de proefomgeving.

Stap 4 - Aansluiten op de proefomgeving

De proefomgeving is een ketentestomgeving waarin je jouw client test in een realistische situatie. Je wisselt hier daadwerkelijk berichten uit met de BRP(-V). Je authenticeert hier via je eigen afnemerId en communiceert daarmee met de BRP(-V) net zoals dit in de productieomgeving zou gebeuren.

Samen met het Test & Deployment team van RvIG doorloop je deze fase. Deze wordt afgesloten met een compliancy-test (voorheen Schouwen en Toetsen). Hierbij wordt vastgesteld of de verwerking door je software van de berichten en de volgorde en de inhoud van de gegevens verklaarbaar is aan de hand van het LO BRP. Na een succesvolle afronding kan jouw aansluiting worden voorbereid op de productieomgeving.

Meer informatie over het aansluiten op de proef- en productieomgeving en de compliancy-test (Schouwen en Toetsen) staat hier beschreven.