From f861f576809c29edece6fc19d1bda2af5dad2b33 Mon Sep 17 00:00:00 2001 From: Viicos <65306057+Viicos@users.noreply.github.com> Date: Mon, 15 Jan 2024 12:17:17 +0100 Subject: [PATCH 1/2] [#3758] Add docs regarding the BRK validation plugin --- docs/configuration/validation/brk.rst | 43 +++++++++++++++++++++++++ docs/configuration/validation/index.rst | 1 + 2 files changed, 44 insertions(+) create mode 100644 docs/configuration/validation/brk.rst diff --git a/docs/configuration/validation/brk.rst b/docs/configuration/validation/brk.rst new file mode 100644 index 0000000000..b3db1ca928 --- /dev/null +++ b/docs/configuration/validation/brk.rst @@ -0,0 +1,43 @@ +.. _configuration_validation_brk: + +========================= +BRK - Zakelijk gerechtigd +========================= + +The special *AddressNL* component has a specific validator available, that can +check if the currently logged in user is the business owner of the filled-in property. + +Configuration +============= + +1. Obtain a BRK API key. +2. In Open Forms, navigate to: **Miscellaneous** > **KvK configuration**. +3. Click **Add** next to the **KvK API Basisprofiel** field and fill in the following + details: + + * **Label**: *Fill in a human readable label*, for example: ``My BRK API`` + * **Type**: ORC (Overige). + * **API root URL**: *The API URL provided by KvK but typically:* ``https://api.brk.kadaster.nl/esd-eto-apikey/bevragen/v2/``. + * **Authorization type**: API key. + * **Header key**: ``X-Api-Key``. + * **Header value**: *The KvK API key obtained in step 1*. + * **OAS file**: ``https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/master/specificatie/genereervariant/openapi.yaml``. + +4. Click **Save** in the popup to save and close it. +5. When building a form, add a *AddressNL* component from the *Special* dropdown. +6. In the **Validation** tab, select *BRK - Zakelijk gerechtigd*. + +.. warning:: + + This validation plugin is only available if an :ref:`authentication plugin ` + that provides a BSN is being used. + + +Technical +========= + +======= ================== +API Supported versions +======= ================== +BRK API 2.0 +======= ================== diff --git a/docs/configuration/validation/index.rst b/docs/configuration/validation/index.rst index 6b58c9b43c..3c761362ca 100644 --- a/docs/configuration/validation/index.rst +++ b/docs/configuration/validation/index.rst @@ -8,3 +8,4 @@ Validation plugins :maxdepth: 1 kvk + brk From c2d7b4469cae0a4e6670f2f6155bcfd531ee2838 Mon Sep 17 00:00:00 2001 From: Viicos <65306057+Viicos@users.noreply.github.com> Date: Mon, 22 Jan 2024 14:31:30 +0100 Subject: [PATCH 2/2] [#3758] PR feedback --- docs/configuration/validation/brk.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/configuration/validation/brk.rst b/docs/configuration/validation/brk.rst index b3db1ca928..0b246a573a 100644 --- a/docs/configuration/validation/brk.rst +++ b/docs/configuration/validation/brk.rst @@ -11,23 +11,25 @@ Configuration ============= 1. Obtain a BRK API key. -2. In Open Forms, navigate to: **Miscellaneous** > **KvK configuration**. -3. Click **Add** next to the **KvK API Basisprofiel** field and fill in the following - details: +2. In Open Forms, navigate to: **Configuration** > **Services**. +3. Click **Add service** and fill in the following details: - * **Label**: *Fill in a human readable label*, for example: ``My BRK API`` + * **Label**: *Fill in a human readable label*, for example: ``Basisregistratie Kadaster (BRK)`` * **Type**: ORC (Overige). * **API root URL**: *The API URL provided by KvK but typically:* ``https://api.brk.kadaster.nl/esd-eto-apikey/bevragen/v2/``. * **Authorization type**: API key. * **Header key**: ``X-Api-Key``. * **Header value**: *The KvK API key obtained in step 1*. - * **OAS file**: ``https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/master/specificatie/genereervariant/openapi.yaml``. -4. Click **Save** in the popup to save and close it. -5. When building a form, add a *AddressNL* component from the *Special* dropdown. -6. In the **Validation** tab, select *BRK - Zakelijk gerechtigd*. +4. Click **Save** +5. Navigate to **Configuration** > **Configuration overview**. In the **Validator plugins** + group, click on **Configuration** for the **Validation plugin config: BRK - Zakelijk gerechtigd** line. +6. Select for the **BRK API**, the **Basisregistratie Kadaster (BRK)** option, that we just created in step 3. +7. Click **Save** +8. When building a form, add an *AddressNL* component from the *Special* group. +9. In the **Validation** tab, select *BRK - Zakelijk gerechtigd*. -.. warning:: +.. note:: This validation plugin is only available if an :ref:`authentication plugin ` that provides a BSN is being used.