GitLocker: The Coding Marketplace

Description:

openformsexthaalcentraalhr 0.3.1

Version:
0.3.1
Source:
https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr

Keywords:
Open Forms Extension, Haal Centraal HR

PythonVersion:
3.10

Open Forms extension to prefill form fields with data coming from the Haal Centraal HR API.

Contents

1 Features
2 Installation
3 Usage
4 Configuration

1 Features

Configuration in the admin for the Haal Centraal service
The Haal Centraal client performs the token exchange with Keycloak
Retrieve prefill data from the MaatschappelijkeActiviteitRaadplegen API endpoint based on KvK number.

Note
The Haal Centraal HR API is a Den Haag specific API and not a national Dutch standard.

2 Installation
Requirements

Python 3.8 or above
setuptools 30.3.1 or above
Django 3.2 or newer

3 Usage
For an explanation of this how this extension works, look at the Open Forms developer documentation.
To see how to build and distribute an image with this extension, look at the Open Forms documentation about
building and distributing extensions.

4 Configuration
In the Open Forms Admin:

Go to Configuration > Services and create a service for Haal Centraal HR.
Go to Miscellaneous > Token exchange plugin configurations.
Click on Add Token exchange plugin configuration and fill in the details:

Select the service for which you want the token authorisation to be performed.
Add the Keycloak audience.

Save the configuration.

The prefill will be available in the form designer in the same way as other prefill plugins.