From 7ea4cda18c58ef788c604e530eda55797a832b88 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:00:40 +0100 Subject: [PATCH 01/23] Update _config.yml --- docs/_config.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index f8cd521..cec5f94 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -16,25 +16,25 @@ nav: - title: Haal Centraal BAG Huidige Bevragingen v. 1.5 (Deprecated) subnav: - title: Functionaliteit en specificaties - path: /getting-started + path: /getting-started-HB - title: User stories - path: /user-stories-prod + path: /user-stories-prod-HB - title: Bevragen API (swagger-ui) - path: /swagger-ui + path: /swagger-ui-HB - title: Bevragen API (redoc) - path: /redoc + path: /redoc-HB - title: Features path: /features - title: BAG Individuele Bevragingen v. 2.6 (Live) subnav: - title: Getting started - path: /getting-started-IB + path: /getting-started - title: User stories - path: /user-stories-prod-IB + path: /user-stories-prod - title: IB API (swagger-ui) - path: /swagger-ui-IB + path: /swagger-ui - title: IB API (redoc) - path: /redoc-IB + path: /redoc # - title: Features # path: https://github.com/lvbag/BAG-API/tree/master/Features # - title: Specificaties v. 1.5 (IO) From ead325302c96ece49eaff32a4d64190628a86f5d Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:01:02 +0100 Subject: [PATCH 02/23] Rename getting-started.md to getting-started-HB.md --- docs/{getting-started.md => getting-started-HB.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{getting-started.md => getting-started-HB.md} (100%) diff --git a/docs/getting-started.md b/docs/getting-started-HB.md similarity index 100% rename from docs/getting-started.md rename to docs/getting-started-HB.md From 6d72ac676fbd0e619f889a27aa9a5c028324d8c8 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:01:19 +0100 Subject: [PATCH 03/23] Rename getting-started-IB.md to getting-started.md --- docs/{getting-started-IB.md => getting-started.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{getting-started-IB.md => getting-started.md} (100%) diff --git a/docs/getting-started-IB.md b/docs/getting-started.md similarity index 100% rename from docs/getting-started-IB.md rename to docs/getting-started.md From b3c7e026438a47ea3eca2a634c48e6ffc1b256af Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:01:45 +0100 Subject: [PATCH 04/23] Rename redoc.md to redoc-HB.md --- docs/{redoc.md => redoc-HB.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename docs/{redoc.md => redoc-HB.md} (82%) diff --git a/docs/redoc.md b/docs/redoc-HB.md similarity index 82% rename from docs/redoc.md rename to docs/redoc-HB.md index 6318bb8..9bb039e 100644 --- a/docs/redoc.md +++ b/docs/redoc-HB.md @@ -4,4 +4,4 @@ title: redoc body_include: redoc-body.html spec-url: https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/master/specificatie/genereervariant/openapi.yaml --- - \ No newline at end of file + From 6c930eec48806d41c7abb68eab6011c4db63886b Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:02:35 +0100 Subject: [PATCH 05/23] Rename redoc-IB.md to redoc.md --- docs/{redoc-IB.md => redoc.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{redoc-IB.md => redoc.md} (100%) diff --git a/docs/redoc-IB.md b/docs/redoc.md similarity index 100% rename from docs/redoc-IB.md rename to docs/redoc.md From e283547649bd85dccdfddcbef262092a64093cae Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:02:57 +0100 Subject: [PATCH 06/23] Rename swagger-ui.md to swagger-ui-HB.md --- docs/{swagger-ui.md => swagger-ui-HB.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{swagger-ui.md => swagger-ui-HB.md} (100%) diff --git a/docs/swagger-ui.md b/docs/swagger-ui-HB.md similarity index 100% rename from docs/swagger-ui.md rename to docs/swagger-ui-HB.md From e8e94710188f73c11991622bf63ddaa6aea6b2ee Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:03:15 +0100 Subject: [PATCH 07/23] Rename swagger-ui-IB.md to swagger-ui.md --- docs/{swagger-ui-IB.md => swagger-ui.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{swagger-ui-IB.md => swagger-ui.md} (100%) diff --git a/docs/swagger-ui-IB.md b/docs/swagger-ui.md similarity index 100% rename from docs/swagger-ui-IB.md rename to docs/swagger-ui.md From 1b3219ecfdf493fe922cdd7c9bb0c27635c42f03 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:03:37 +0100 Subject: [PATCH 08/23] Rename user-stories-prod.md to user-stories-prod-HB.md --- docs/{user-stories-prod.md => user-stories-prod-HB.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{user-stories-prod.md => user-stories-prod-HB.md} (100%) diff --git a/docs/user-stories-prod.md b/docs/user-stories-prod-HB.md similarity index 100% rename from docs/user-stories-prod.md rename to docs/user-stories-prod-HB.md From 5cf78bd22008d493c1db5414d9fd02834f1bc0bb Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:03:53 +0100 Subject: [PATCH 09/23] Rename user-stories-prod-IB.md to user-stories-prod.md --- docs/{user-stories-prod-IB.md => user-stories-prod.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{user-stories-prod-IB.md => user-stories-prod.md} (100%) diff --git a/docs/user-stories-prod-IB.md b/docs/user-stories-prod.md similarity index 100% rename from docs/user-stories-prod-IB.md rename to docs/user-stories-prod.md From 3f0aaf3ed165aded83b47b4626cbb4fc7b096aa1 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:04:37 +0100 Subject: [PATCH 10/23] Delete docs/user-stories.md --- docs/user-stories.md | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 docs/user-stories.md diff --git a/docs/user-stories.md b/docs/user-stories.md deleted file mode 100644 index 36504e2..0000000 --- a/docs/user-stories.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: page-with-side-nav -title: user stories ---- -# User stories - -Bekijk de user stories in [GitHub](https://github.com/VNG-Realisatie{{ site.baseurl }}/issues?q=is%3Aopen+is%3Aissue+label%3A%22user+story%22){:target="_blank"} From 59550cad4d37a89421f4f191b0e223199d4ed0b6 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:16:54 +0100 Subject: [PATCH 11/23] Update index.md --- docs/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index 455714f..2337f4a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,16 +7,16 @@ title: Haal Centraal BAG Huidige Bevragingen -Deze API voor het zoeken en raadplegen van adressen, adresseerbaar objecten en panden uit de Basisregistratie Adressen en Gebouwen (BAG) wordt geintegreerd in de BAG API Individuele Bevragingen. Als gebruiker van de BAG API Huidige Bevragingen heb je tot 1 juli 2023 de tijd om over te stappen. +BAG Individuele bevragingen is een API voor het zoeken en raadplegen van gegevens in de basisregistratie Adressen en Gebouwen voor alle binnengemeentelijke afnemers in NL, maar ook voor waterschappen, belastingsamenwerkingen en andere overheden. We doen ons uiterste best om de API evolvable door te ontwikkelen en geen breaking changes te introduceren. -Tijdens de doorontwikkeling die de afgelopen jaren heeft plaatsgevonden, zijn de beide BAG API’s dusdanig naar elkaar toe gegroeid, dat het efficiënter is om de BAG API’s te integreren. Het Kadaster en VNG Realisatie hebben de afgelopen maanden gewerkt aan de integratie van de twee BAG API’s: Huidige Bevragingen (Haal Centraal) en Individuele Bevragingen. Alle functionaliteiten van de BAG API Huidige Bevragingen zijn nu toegevoegd aan de BAG API Individuele Bevragingen. Zodra de nieuwe versie van BAG Individuele Bevragingen in productie gaat, vind je de specificaties en de Getting Started van de BAG Individuele Bevragingen API op deze website. +Bekijk de [release notes](./releasenotes.md) van deze release. Bezoek de [GitHub repository](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/). # Direct aan de slag? -* Bekijk de specificaties met [Swagger UI](./swagger-ui-IB) of [Redoc](./redoc-IB) -* Lees de [Getting started](./getting-started-IB) +* Bekijk de specificaties met [Swagger UI](./swagger-ui) of [Redoc](./redoc) +* Lees de [Getting started](./getting-started) * Download de [technische specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/master/specificatie/genereervariant/openapi.yaml){:target="_blank"} * [Vraag een API-key aan](https://formulieren.kadaster.nl/aanvraag_bag_api_individuele_bevragingen_productie){:target="_blank"} voor toegang tot de productieomgeving. @@ -25,7 +25,7 @@ Bezoek de [GitHub repository](https://github.com/VNG-Realisatie/Haal-Centraal-BA * [API Design Visie](https://github.com/Geonovum/KP-APIs/blob/master/overleggen/Werkgroep%20API%20design%20visie/API%20Design%20Visie.md){:target="_blank" rel="noopener"} * [REST API Design Rules](https://docs.geostandaarden.nl/api/API-Designrules/){:target="_blank" rel="noopener"} * [Landelijke API strategie voor de overheid](https://geonovum.github.io/KP-APIs/){:target="_blank" rel="noopener"} -* [Stelselcatalogus](https://www.stelselcatalogus.nl/registraties/BAG/){:target="_blank" rel="noopener"} +* [Stelselcatalogus]([https://www.stelselcatalogus.nl/registraties/BAG/](https://www.stelselcatalogus.nl/registraties/registratie?id=http://opendata.stelselcatalogus.nl/id/registratie/BAG)){:target="_blank" rel="noopener"} ## Contact From 2e0d46a2b6d3d7f86dbeb47c19c10c056bf0a299 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:17:22 +0100 Subject: [PATCH 12/23] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 2337f4a..5a539a2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ layout: page-with-side-nav title: Haal Centraal BAG Huidige Bevragingen --- -# Haal Centraal BAG Huidige Bevragingen wordt geintegreerd in BAG Individuele Bevragingen! +# BAG Individuele Bevragingen From 1097c003baadfa7fd8bfb50be8a982247d17d965 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:17:38 +0100 Subject: [PATCH 13/23] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 5a539a2..b7447e6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ --- layout: page-with-side-nav -title: Haal Centraal BAG Huidige Bevragingen +title: BAG Individuele Bevragingen --- # BAG Individuele Bevragingen From 428a6fa3fcff9e46627c0fbd550608c738644994 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:18:23 +0100 Subject: [PATCH 14/23] Update _config.yml --- docs/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index cec5f94..da413e1 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -13,7 +13,7 @@ nav: path: / - title: Goals canvas path: /goals-canvas - - title: Haal Centraal BAG Huidige Bevragingen v. 1.5 (Deprecated) + - title: Haal Centraal BAG Huidige Bevragingen v. 1.5 (Expired) subnav: - title: Functionaliteit en specificaties path: /getting-started-HB From de967cd630e4cc01eb5b39d6fde10ccbc0586551 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:33:20 +0100 Subject: [PATCH 15/23] Update getting-started-HB.md --- docs/getting-started-HB.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/getting-started-HB.md b/docs/getting-started-HB.md index 8cb02dd..65b0fc1 100644 --- a/docs/getting-started-HB.md +++ b/docs/getting-started-HB.md @@ -4,11 +4,11 @@ title: Functionaliteit en specificaties --- # Functionaliteit en specificaties - BAG Huidige Bevragingen API -## De BAG Huidige Bevragingen API v 1.5 is deprecated en wordt met ingang van 1 juli a.s. niet meer ondersteund. +## De BAG Huidige Bevragingen API v 1.5 is expired. -Wij adviseren niet meer te starten met de implementatie van deze API en verwijzen je naar de [Getting Started van de BAG Individuele Bevragingen v. 2.6](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/getting-started-IB) die deze API gaat vervangen. Onderstaande informatie is alleen bedoelt voor de huidige gebruikers van deze API. +Start niet meer met de implementatie van deze API. Implementeer daarvoor in plaats de BAG Individuele Bevragingen API, we verwijzen je daarvoor naar de [Getting Started van de BAG Individuele Bevragingen v. 2.6](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/getting-started).

Onderstaande informatie is alleen bedoelt voor evt. resterende gebruikers van de BAG Huidige Bevragingen API. -Je kunt de Open API Specificaties (OAS3) van de API bekijken in [Swagger-formaat](./swagger-ui) of [Redoc](./redoc). +Je kunt de Open API Specificaties (OAS3) van de API bekijken in [Swagger-formaat](./swagger-ui-HB) of [Redoc](./redoc-HB). De (resolved) OAS3 is hier te downloaden: [openapi.yaml](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/master/specificatie/genereervariant/openapi.yaml){:target="_blank" rel="noopener"}. @@ -75,10 +75,10 @@ Verder zijn er nog een paar algemene functies die gelden voor alle bovenstaande ## Test de API De werking van de API is het makkelijkst te testen met behulp van [Postman](https://www.getpostman.com/){:target="_blank"}. De [openapi.yaml](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/master/specificatie/genereervariant/openapi.yaml){:target="_blank"} kun je importeren als project, waarna de verschillende requests worden ingeladen die deze API ondersteunt. -We hebben al een project voor je gemaakt die je kan gebruiken: [BAG-Bevragen-postman-collection.json](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/master/test/BAG-Bevragen-postman-collection.json){:target="_blank"}. Hierin moet je alleen de base url en authenticatie (API-key) nog invullen. +Je kunt ook het project dat we voor je heben gemaakt gebruiken: [BAG-Bevragen-postman-collection.json](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/master/test/BAG-Bevragen-postman-collection.json){:target="_blank"}. Hierin moet je alleen de base url en authenticatie (API-key) nog invullen. -### API key -Om de API te kunnen bevragen is de API key nodig die je al eerder hebt ontvangen. Deze moet je bij het request opnemen in request header "X-Api-Key". + ### Testgevallen Onderstaande tabellen bevatten testgevallen voor specifieke situaties waarmee de werking van de API kan worden getest. @@ -101,6 +101,6 @@ Onderstaande tabellen bevatten testgevallen voor specifieke situaties waarmee de | panden | Zonder adres | /panden/0503100000034877 | Tip: Je kan ook de [BAG Viewer](https://bagviewer.kadaster.nl/lvbag/bag-viewer/index.html){:target="_blank"} gebruiken om meer testgevallen te zoeken. - + From 793658719a87e3e05d0e52478a5c43db632a3c74 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:40:09 +0100 Subject: [PATCH 16/23] Update getting-started.md --- docs/getting-started.md | 47 ++++++++++++++++++----------------------- 1 file changed, 21 insertions(+), 26 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 09e35da..833fdc4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -24,21 +24,17 @@ De (resolved) OAS3 is hier te downloaden: [openapi.yaml](https://api.bag.kadaste De API kent de volgende endpoints: -• *Woonplaatsen* -• *Openbare ruimten* -• *Nummeraanduidingen* -• *Verblijfsobjecten* -• *Standplaatsen* -• *Ligplaatsen* -• *Panden* -• *Bronhouders* - - -• *Adressen*: hierin zijn samenhangende en gerelateerde gegevens samengevoegd uit de nummeraanduiding, openbare ruimte en woonplaats die samen een adres vormen. - -• *Adressen uitgebreid*: deze resource ondersteunt de mogelijkheid om met één bevraging meer informatie over het adres op te halen, zoals het bouwjaar en de gebruiksoppervlakte. - -• *Adresseerbare objecten*: dit kan een verblijfsobject, ligplaats of standplaats zijn. +* *Woonplaatsen* +* *Openbare ruimten* +* *Nummeraanduidingen* +* *Verblijfsobjecten* +* *Standplaatsen* +* *Ligplaatsen* +* *Panden* +* *Bronhouders* +* *Adressen*:
hierin zijn samenhangende en gerelateerde gegevens samengevoegd uit de nummeraanduiding, openbare ruimte en woonplaats die samen een adres vormen. +* *Adressen uitgebreid*:
deze resource ondersteunt de mogelijkheid om met één bevraging meer informatie over het adres op te halen, zoals het bouwjaar en de gebruiksoppervlakte. +* *Adresseerbare objecten*:
dit kan een verblijfsobject, ligplaats of standplaats zijn. De objecten endpoints leveren één of meer (voorkomens van) object(en), met embedded resources en links. @@ -53,21 +49,21 @@ In de tabel [Wat zit in welk endpoint](https://github.com/lvbag/BAG-API/blob/mas Er zijn een aantal algemene functies die gelden voor bovenstaande aanvragen: - • De expand resource is te gebruiken om binnen een response extra informatie te ontvangen over een van de objecttypen. Zo kan bijvoorbeeld bij een adres de volledige informatie (inclusief registratie tijdstippen) van een openbare ruimte worden opgevraagd door expand=openbareruimte mee te nemen in de bevraging. Voor de werking, zie feature [expand.](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature) +* De expand resource is te gebruiken om binnen een response extra informatie te ontvangen over een van de objecttypen. Zo kan bijvoorbeeld bij een adres de volledige informatie (inclusief registratie tijdstippen) van een openbare ruimte worden opgevraagd door expand=openbareruimte mee te nemen in de bevraging. Voor de werking, zie feature [expand.](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature) -• De functionaliteit exacte match biedt de mogelijkheid om een specifiek object te bevragen. Ook wanneer er meerdere objecten aan de opgegeven parameters voldoen. Parameter exacteMatch=true werkt als een filter op de objecten die voldoen aan de opgegeven parameters huisnummer, huisletter en huisnummertoevoeging. De endpoints waar exacte match kan worden toegepast kennen geen fuzzy search. Voor de werking, zie feature [exacte match.](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature) +* De functionaliteit exacte match biedt de mogelijkheid om een specifiek object te bevragen. Ook wanneer er meerdere objecten aan de opgegeven parameters voldoen. Parameter exacteMatch=true werkt als een filter op de objecten die voldoen aan de opgegeven parameters huisnummer, huisletter en huisnummertoevoeging. De endpoints waar exacte match kan worden toegepast kennen geen fuzzy search. Voor de werking, zie feature [exacte match.](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature) -• Er wordt paginering gebruikt om het aantal zoekresultaten per zoekvraag te beperken. Met de page parameter kan een volgende pagina worden gevraagd. Met de pageSize parameter kan gekozen worden voor meer of minder zoekresultaten per pagina (standaard is 20, maximum is 100). Voor de werking, zie feature [paginering.](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature) +* Er wordt paginering gebruikt om het aantal zoekresultaten per zoekvraag te beperken. Met de page parameter kan een volgende pagina worden gevraagd. Met de pageSize parameter kan gekozen worden voor meer of minder zoekresultaten per pagina (standaard is 20, maximum is 100). Voor de werking, zie feature [paginering.](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature) -• Bij enkele endpoints wordt de mogelijkheid geboden om met de parameter Huidig alleen huidige objecten op te vragen. Huidig betekent dat het object actueel is en geen eindstatus heeft. De endpoints Adressen en Adressen uitgebreid leveren alleen huidige gegevens. Voor meer informatie, zie feature [huidig.](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature) +* Bij enkele endpoints wordt de mogelijkheid geboden om met de parameter Huidig alleen huidige objecten op te vragen. Huidig betekent dat het object actueel is en geen eindstatus heeft. De endpoints Adressen en Adressen uitgebreid leveren alleen huidige gegevens. Voor meer informatie, zie feature [huidig.](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature) -• Soms kan een onderzoek lopen naar de juistheid van een gegeven. Er zijn dan twijfels over de juistheid van de geregistreerde waarde. De API levert deze waarde wel, maar neemt die velden dan op in Inonderzoek met de waarde True. Voor de werking, zie feature [Inonderzoek bij adressen en adressenUitgebreid.](https://github.com/lvbag/BAG-API/blob/master/Features/inonderzoek-bij-adressen-en-adressen-uitgebreid.feature) +* Soms kan een onderzoek lopen naar de juistheid van een gegeven. Er zijn dan twijfels over de juistheid van de geregistreerde waarde. De API levert deze waarde wel, maar neemt die velden dan op in Inonderzoek met de waarde True. Voor de werking, zie feature [Inonderzoek bij adressen en adressenUitgebreid.](https://github.com/lvbag/BAG-API/blob/master/Features/inonderzoek-bij-adressen-en-adressen-uitgebreid.feature) -• De gegevens die worden geleverd met de endpoints adressen en adressen uitgebreid zijn huidige gegevens. Door middel van de boolean inclusief eindstatus, is het mogelijk om ook adressen te zoeken waarbij één van de bronobjecten (nummeraanduiding, openbare ruimte en woonplaats) een eindstatus heeft. +* De gegevens die worden geleverd met de endpoints adressen en adressen uitgebreid zijn huidige gegevens. Door middel van de boolean inclusief eindstatus, is het mogelijk om ook adressen te zoeken waarbij één van de bronobjecten (nummeraanduiding, openbare ruimte en woonplaats) een eindstatus heeft. -• Sommige resources bevatten geometrie. De API ondersteunt op dit moment alleen het RD coördinatenstelsel (epsg:28992). Bij een aanvraag die geometrie teruglevert, moet de request header Accept-Crs worden meegestuurd. +* Sommige resources bevatten geometrie. De API ondersteunt op dit moment alleen het RD coördinatenstelsel (epsg:28992). Bij een aanvraag die geometrie teruglevert, moet de request header Accept-Crs worden meegestuurd. -• Bij het zoeken naar panden en adresseerbare objecten kan gebruik worden gemaakt van een boundingbox. +* Bij het zoeken naar panden en adresseerbare objecten kan gebruik worden gemaakt van een boundingbox. ### Uitwerking Use cases @@ -114,7 +110,6 @@ Het gebruik van de BAG API Individuele Bevragingen is kosteloos. Bij het gebruik ## Implementeer de API client Client code kan worden gegenereerd met de “[genereervariant](https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml)” van de API-specificaties en een code generator. Een overzicht met codegeneratoren is te vinden op [OpenAPI.Tools.](https://openapi.tools/#sdk) - ## Probeer en test de API De werking van de API is het gemakkelijkst te testen met behulp van [Postman](https://www.getpostman.com/). De [openapi.yaml](https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml) kan je importeren als project, waarna de verschillende requests worden ingeladen die deze API ondersteunt. @@ -150,8 +145,8 @@ Tip: Je kan ook de [BAG Viewer](https://bagviewer.kadaster.nl/lvbag/bag-viewer/i De API is te benaderen via de volgende url: -Testomgeving: +**Testomgeving**: https://api.bag.acceptatie.kadaster.nl/lvbag/individuelebevragingen/v2/ -Productieomgeving: +**Productieomgeving**: https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/ From fa1c193abd3bdf3d549a7fc5f7e0217d217a724c Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 09:48:01 +0100 Subject: [PATCH 17/23] Update README.md --- README.md | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 0758701..7449614 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,16 @@ -# Haal Centraal BAG Huidige Bevragingen +# BAG Individuele Bevragingen -![lint oas](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/workflows/lint-oas/badge.svg) -![generate postman collection](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/workflows/generate-postman-collection/badge.svg) + -BAG Huidige bevragingen is een Haal Centraal API voor het zoeken en raadplegen van gegevens in de basisregistratie Adressen en Gebouwen voor alle binnengemeentelijke afnemers in NL, maar ook voor waterschappen, belastingsamenwerkingen en andere overheden. -We doen ons uiterste best om de API evolvable door te ontwikkelen en geen breaking changes te introduceren. +BAG Individuele bevragingen is een API voor het zoeken en raadplegen van gegevens in de basisregistratie Adressen en Gebouwen voor alle binnengemeentelijke afnemers in NL, maar ook voor waterschappen, belastingsamenwerkingen en andere overheden. We doen ons uiterste best om de API evolvable door te ontwikkelen en geen breaking changes te introduceren. Bekijk de [release notes](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/releasenotes) van deze release. +Bezoek de [GitHub repository](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/). + +# Haal Centraal BAG Huidige Bevragingen + ## Direct aan de slag? * Bekijk de specificaties met [Swagger UI](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/swagger-ui) of [Redoc](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/redoc) @@ -15,14 +18,12 @@ Bekijk de [release notes](https://vng-realisatie.github.io/Haal-Centraal-BAG-bev * Download de [technische specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/master/specificatie/genereervariant/openapi.yaml) * [Vraag een API-key aan](https://formulieren.kadaster.nl/aanvraag_bag_api_huidige_bevragingen_productie) voor toegang tot de productieomgeving. - ## Bronnen -* [Productvisie Haal Centraal](https://vng-realisatie.github.io/Haal-Centraal) -* [API Design Visie](https://github.com/Geonovum/KP-APIs/blob/master/overleggen/Werkgroep%20API%20design%20visie/API%20Design%20Visie.md) -* [REST API Design Rules](https://docs.geostandaarden.nl/api/API-Designrules/) -* [Landelijke API strategie voor de overheid](https://geonovum.github.io/KP-APIs/) -* [Stelselcatalogus](https://www.stelselcatalogus.nl/registraties/BAG/) +* [API Design Visie](https://github.com/Geonovum/KP-APIs/blob/master/overleggen/Werkgroep%20API%20design%20visie/API%20Design%20Visie.md){:target="_blank" rel="noopener"} +* [REST API Design Rules](https://docs.geostandaarden.nl/api/API-Designrules/){:target="_blank" rel="noopener"} +* [Landelijke API strategie voor de overheid](https://geonovum.github.io/KP-APIs/){:target="_blank" rel="noopener"} +* [Stelselcatalogus]([https://www.stelselcatalogus.nl/registraties/BAG/](https://www.stelselcatalogus.nl/registraties/registratie?id=http://opendata.stelselcatalogus.nl/id/registratie/BAG)){:target="_blank" rel="noopener"} ## Contact @@ -30,14 +31,18 @@ Bekijk de [release notes](https://vng-realisatie.github.io/Haal-Centraal-BAG-bev [Maak een bug issue aan >>](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/new?assignees=&labels=bug&template=bug_report.md&title=) * Verbeteringen doorgeven [Maak een verbeter issue aan >>](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=) +* Storingen + [Meld een storing](https://formulieren.kadaster.nl/contact_kadaster) * Community: Wil je geïnformeerd blijven over productwijzigingen of meepraten over de API meld je dan aan bij de community.
Ga naar de community>> -* Regiseur API's: Arjen Brienen, [arjen.brienen@VNG.NL](mailto:arjen.brienen@VNG.NL) -* Designer: Johan Boer, [johan.boer@vng.nl](mailto:johan.boer@vng.nl) -* Designer: Robert Melskens, [robert.melskens@vng.nl](mailto:robert.melskens@vng.nl) +* Regiseur API's: Arjen Brienen +* Designer: Johan Boer +* Designer: Robert Melskens + +U kunt hen bereiken via [standaarden.ondersteuning@vng.nl](mailto:standaarden.ondersteuning@vng.nl) ## Licentie Copyright © VNG Realisatie 2020 -Licensed under the [EUPL](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/blob/master/LICENCE.md) +Licensed under the [EUPL](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/blob/master/LICENCE.md){:target="_blank" rel="noopener"} From 9b08bf05b82fff1b04a996089424813508f69dbc Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 10:11:20 +0100 Subject: [PATCH 18/23] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 7449614..c1f78e6 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,6 @@ Bekijk de [release notes](https://vng-realisatie.github.io/Haal-Centraal-BAG-bev Bezoek de [GitHub repository](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/). -# Haal Centraal BAG Huidige Bevragingen - ## Direct aan de slag? * Bekijk de specificaties met [Swagger UI](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/swagger-ui) of [Redoc](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/redoc) From 9393adef6a07cd9dee1c6e4073ba115035448944 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 10:34:48 +0100 Subject: [PATCH 19/23] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c1f78e6..61a01d8 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Bezoek de [GitHub repository](https://github.com/VNG-Realisatie/Haal-Centraal-BA * [API Design Visie](https://github.com/Geonovum/KP-APIs/blob/master/overleggen/Werkgroep%20API%20design%20visie/API%20Design%20Visie.md){:target="_blank" rel="noopener"} * [REST API Design Rules](https://docs.geostandaarden.nl/api/API-Designrules/){:target="_blank" rel="noopener"} * [Landelijke API strategie voor de overheid](https://geonovum.github.io/KP-APIs/){:target="_blank" rel="noopener"} -* [Stelselcatalogus]([https://www.stelselcatalogus.nl/registraties/BAG/](https://www.stelselcatalogus.nl/registraties/registratie?id=http://opendata.stelselcatalogus.nl/id/registratie/BAG)){:target="_blank" rel="noopener"} +* [Stelselcatalogus](https://www.stelselcatalogus.nl/registraties/registratie?id=http://opendata.stelselcatalogus.nl/id/registratie/BAG){:target="_blank" rel="noopener"} ## Contact From 715f0253910da2ee67a3055378d0755b49f6c14b Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 13:22:50 +0100 Subject: [PATCH 20/23] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 61a01d8..c762484 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,10 @@ Bezoek de [GitHub repository](https://github.com/VNG-Realisatie/Haal-Centraal-BA ## Bronnen -* [API Design Visie](https://github.com/Geonovum/KP-APIs/blob/master/overleggen/Werkgroep%20API%20design%20visie/API%20Design%20Visie.md){:target="_blank" rel="noopener"} -* [REST API Design Rules](https://docs.geostandaarden.nl/api/API-Designrules/){:target="_blank" rel="noopener"} -* [Landelijke API strategie voor de overheid](https://geonovum.github.io/KP-APIs/){:target="_blank" rel="noopener"} -* [Stelselcatalogus](https://www.stelselcatalogus.nl/registraties/registratie?id=http://opendata.stelselcatalogus.nl/id/registratie/BAG){:target="_blank" rel="noopener"} +* [API Design Visie](https://github.com/Geonovum/KP-APIs/blob/master/overleggen/Werkgroep%20API%20design%20visie/API%20Design%20Visie.md) +* [REST API Design Rules](https://docs.geostandaarden.nl/api/API-Designrules/) +* [Landelijke API strategie voor de overheid](https://geonovum.github.io/KP-APIs/) +* [Stelselcatalogus](https://www.stelselcatalogus.nl/registraties/registratie?id=http://opendata.stelselcatalogus.nl/id/registratie/BAG) ## Contact From 5d027b7414e2ee9ad32874180f54d8e3ffdb1aa0 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Thu, 4 Jan 2024 13:29:59 +0100 Subject: [PATCH 21/23] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index c762484..2832122 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,6 @@ BAG Individuele bevragingen is een API voor het zoeken en raadplegen van gegeven Bekijk de [release notes](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/releasenotes) van deze release. -Bezoek de [GitHub repository](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/). - ## Direct aan de slag? * Bekijk de specificaties met [Swagger UI](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/swagger-ui) of [Redoc](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/redoc) From fcacd59f8d29dce17bff0fd77013c4f1212667a6 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Mon, 8 Jan 2024 10:37:35 +0100 Subject: [PATCH 22/23] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index b7447e6..afd3796 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,7 +25,7 @@ Bezoek de [GitHub repository](https://github.com/VNG-Realisatie/Haal-Centraal-BA * [API Design Visie](https://github.com/Geonovum/KP-APIs/blob/master/overleggen/Werkgroep%20API%20design%20visie/API%20Design%20Visie.md){:target="_blank" rel="noopener"} * [REST API Design Rules](https://docs.geostandaarden.nl/api/API-Designrules/){:target="_blank" rel="noopener"} * [Landelijke API strategie voor de overheid](https://geonovum.github.io/KP-APIs/){:target="_blank" rel="noopener"} -* [Stelselcatalogus]([https://www.stelselcatalogus.nl/registraties/BAG/](https://www.stelselcatalogus.nl/registraties/registratie?id=http://opendata.stelselcatalogus.nl/id/registratie/BAG)){:target="_blank" rel="noopener"} +* [Stelselcatalogus](https://www.stelselcatalogus.nl/registraties/registratie?id=http://opendata.stelselcatalogus.nl/id/registratie/BAG){:target="_blank" rel="noopener"} ## Contact From ab24de585bfa769d043fb4dabfc08d49792cb486 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Mon, 8 Jan 2024 14:20:06 +0100 Subject: [PATCH 23/23] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index afd3796..b76aa79 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,7 +17,7 @@ Bezoek de [GitHub repository](https://github.com/VNG-Realisatie/Haal-Centraal-BA * Bekijk de specificaties met [Swagger UI](./swagger-ui) of [Redoc](./redoc) * Lees de [Getting started](./getting-started) -* Download de [technische specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/master/specificatie/genereervariant/openapi.yaml){:target="_blank"} +* Download de [technische specificaties](https://github.com/lvbag/BAG-API/blob/master/Technische%20specificatie/Archief/Yaml's/BAG%20API%20Individuele%20Bevragingen/resolved/individuelebevragingen/v2/openapi.yaml){:target="_blank"} * [Vraag een API-key aan](https://formulieren.kadaster.nl/aanvraag_bag_api_individuele_bevragingen_productie){:target="_blank"} voor toegang tot de productieomgeving. ## Bronnen