Instructie uitgifte API (GMN)

U kunt volledig geautomatiseerd BRO-gegevens opvragen (via een SOAP XML-API). Dit is vooral handig als u regelmatig BRO-gegevens nodig heeft. Hieronder beschrijven we in 3 stappen hoe u kunt aansluiten op BRO uitgifte API van Grondwatermonitoringnet (GMN) en wat alternatieve mogelijkheden zijn om BRO-gegevens op te vragen.

Stap 3 is niet van toepassing als u software ontwikkelt en tegen de demo-omgeving aan wilt programmeren.

Stap 1: aansluiten op de demo-omgeving

Allereerst is aanmelden bij de BRO als data-afnemer noodzakelijk. U ontvangt vervolgens van de Servicedesk een testcertificaat. Met dat certificaat en deze uitleg over de installatie van dat certificaat, kunt u vervolgens aansluiten op de demo-omgeving van de BRO uitgifte API en een simpel request aanmaken. Na het aansluiten op de demo-omgeving, kunt u verder met stap 2.

Om uw software aan te passen om het juiste BRO-verzoek te laten genereren, zijn ook deze technische XML schema definities (XSD’s) beschikbaar. U vindt daar generieke BRO schema’s (brocommon) en specifieke (GMN) schema’s (o.a. gmncommon). Daarbij staat 'ds' voor dispatch en 'is' voor inname. Voor het opvragen van gegevens heeft u de ds-schema's nodig.

Ook kunt u deze voorbeeldberichten gebruiken.

In de Berichtencatalogus voor uitgiftewebservice Grondwatermonitoringnet wordt beschreven hoe u als afnemer de gegevens van een grondwatermonitoringnet (GMN) kunt opvragen in een BRO-verzoek voor de Basisregistratie Ondergrond (BRO).

Stap 2: de inhoud van een BRO-verzoek maken

Zodra u aangesloten bent op de demo-omgeving, kunt u de inhoud van een BRO-verzoek verder bepalen met de gegevensstandaard:

  1. Catalogus Grondwatermonitoringnet

Stap 3: aansluiten op de productieomgeving

Om daadwerkelijk gegevens op te kunnen vragen, moet u aansluiten op de productieomgeving. In die productieomgeving is het niet mogelijk om gebruik te maken van het testcertificaat. U heeft dan een PKIoverheid services server certificaat nodig. Dit certificaat is te verkrijgen bij diverse leveranciers.

De overgang van de inregelomgeving naar de productieomgeving, is vervolgens niet meer dan het aanpassen van het endpoint. Gebruik het endpoint voor productieomgeving van GMN. Als het endpoint is aangepast, is de aansluiting op de BRO uitgifte API voor dit registratieobject gerealiseerd.

Andere mogelijkheden

  1. BRO-gegevens opvragen zonder PKI-certificaat met REST uitgifteservices. Voor een aantal registratieobjecten zijn deze REST services beschikbaar. Deze service is zelf-beschrijvend volgens de OPEN API standaard. De swagger-ui pagina geeft de mogelijkheid tot het proberen van de service.
  2. BRO-gegevens online bekijken. Gegevens die geregistreerd worden in de BRO zijn een dag later beschikbaar via het BROloket. U kunt de gegevens op de kaart aan de hand van allerlei criteria bekijken en direct opvragen.

  3. BRO-gegevens voor uw database. Via het BROloket en PDOK (Publieke Dienstverlening op de Kaart), kunt u bestanden met BRO-gegevens opvragen. Lees op het BROloket en PDOK wat de formaten en mogelijkheden zijn.