=============================================
Open Forms extension Haal centraal HR prefill
=============================================
: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
|build-status| |code-quality| |black| |coverage| |docs|
|python-versions| |django-versions| |pypi-version|
Open Forms extension to prefill form fields with data coming from the `Haal Centraal HR API`_.
.. _Haal Centraal HR API: https://app.swaggerhub.com/apis/DH-Sandbox/handelsregister/1.3.0
.. contents::
.. section-numbering::
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.
Installation
============
Requirements
------------
* Python 3.8 or above
* setuptools 30.3.1 or above
* Django 3.2 or newer
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`_.
.. _developer documentation: https://open-forms.readthedocs.io/en/latest/developers/extensions.html#keycloak-token-exchange-extension
.. _building and distributing extensions: https://open-forms.readthedocs.io/en/latest/developers/extensions.html#keycloak-token-exchange-extension
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.
.. |build-status| image:: https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/workflows/Run%20CI/badge.svg
:alt: Build status
:target: https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/actions?query=workflow%3A%22Run+CI%22
.. |code-quality| image:: https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/workflows/Code%20quality%20checks/badge.svg
:alt: Code quality checks
:target: https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/actions?query=workflow%3A%22Code+quality+checks%22
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |coverage| image:: https://codecov.io/github/open-formulieren/open-forms-ext-haalcentraal-hr/branch/main/graph/badge.svg
:target: https://codecov.io/gh/open-formulieren/open-forms-ext-haalcentraal-hr
:alt: Coverage status
.. |docs| image:: https://readthedocs.org/projects/prefill_haalcentraalhr/badge/?version=latest
:target: https://prefill_haalcentraalhr.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/open-forms-ext-haalcentraal-hr.svg
.. |django-versions| image:: https://img.shields.io/pypi/djversions/open-forms-ext-haalcentraal-hr.svg
.. |pypi-version| image:: https://img.shields.io/pypi/v/open-forms-ext-haalcentraal-hr.svg
:target: https://pypi.org/project/open-forms-ext-haalcentraal-hr/
Raw data
{
"_id": null,
"home_page": "https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr",
"name": "open-forms-ext-haalcentraal-hr",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "TODO",
"author": "Maykin Media",
"author_email": "support@maykinmedia.nl",
"download_url": "https://files.pythonhosted.org/packages/4d/7b/25a60ec0217b21a74d71758c69736e1800e19f777beecda0a79ac0612324/open-forms-ext-haalcentraal-hr-0.3.1.tar.gz",
"platform": null,
"description": "\n=============================================\nOpen Forms extension Haal centraal HR prefill\n=============================================\n\n:Version: 0.3.1\n:Source: https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr\n:Keywords: Open Forms Extension, Haal Centraal HR\n:PythonVersion: 3.10\n\n|build-status| |code-quality| |black| |coverage| |docs|\n\n|python-versions| |django-versions| |pypi-version|\n\nOpen Forms extension to prefill form fields with data coming from the `Haal Centraal HR API`_.\n\n.. _Haal Centraal HR API: https://app.swaggerhub.com/apis/DH-Sandbox/handelsregister/1.3.0\n\n.. contents::\n\n.. section-numbering::\n\nFeatures\n========\n\n* Configuration in the admin for the Haal Centraal service\n* The Haal Centraal client performs the token exchange with Keycloak\n* Retrieve prefill data from the ``MaatschappelijkeActiviteitRaadplegen`` API endpoint based on KvK number.\n\n.. note::\n\n The Haal Centraal HR API is a Den Haag specific API and not a national Dutch standard.\n\nInstallation\n============\n\nRequirements\n------------\n\n* Python 3.8 or above\n* setuptools 30.3.1 or above\n* Django 3.2 or newer\n\n\nUsage\n=====\n\nFor an explanation of this how this extension works, look at the Open Forms `developer documentation`_.\n\nTo see how to build and distribute an image with this extension, look at the Open Forms documentation about\n`building and distributing extensions`_.\n\n.. _developer documentation: https://open-forms.readthedocs.io/en/latest/developers/extensions.html#keycloak-token-exchange-extension\n.. _building and distributing extensions: https://open-forms.readthedocs.io/en/latest/developers/extensions.html#keycloak-token-exchange-extension\n\n\nConfiguration\n=============\n\nIn the Open Forms Admin:\n\n* Go to **Configuration** > **Services** and create a service for Haal Centraal HR.\n* Go to **Miscellaneous** > **Token exchange plugin configurations**.\n Click on **Add Token exchange plugin configuration** and fill in the details:\n\n * Select the service for which you want the token authorisation to be performed.\n * Add the Keycloak audience.\n\n Save the configuration.\n* The prefill will be available in the form designer in the same way as other prefill plugins.\n\n\n.. |build-status| image:: https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/workflows/Run%20CI/badge.svg\n :alt: Build status\n :target: https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/actions?query=workflow%3A%22Run+CI%22\n\n.. |code-quality| image:: https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/workflows/Code%20quality%20checks/badge.svg\n :alt: Code quality checks\n :target: https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/actions?query=workflow%3A%22Code+quality+checks%22\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. |coverage| image:: https://codecov.io/github/open-formulieren/open-forms-ext-haalcentraal-hr/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/open-formulieren/open-forms-ext-haalcentraal-hr\n :alt: Coverage status\n\n.. |docs| image:: https://readthedocs.org/projects/prefill_haalcentraalhr/badge/?version=latest\n :target: https://prefill_haalcentraalhr.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/open-forms-ext-haalcentraal-hr.svg\n\n.. |django-versions| image:: https://img.shields.io/pypi/djversions/open-forms-ext-haalcentraal-hr.svg\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/open-forms-ext-haalcentraal-hr.svg\n :target: https://pypi.org/project/open-forms-ext-haalcentraal-hr/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "TODO",
"version": "0.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/issues",
"Changelog": "https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr/blob/main/CHANGELOG.rst",
"Documentation": "http://prefill_haalcentraalhr.readthedocs.io/en/latest/",
"Homepage": "https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr",
"Source Code": "https://github.com/open-formulieren/open-forms-ext-haalcentraal-hr"
},
"split_keywords": [
"todo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be73224d76d136413026146ccf9bceb91c6f75e2a2204fb0d50a21e59d75d48f",
"md5": "f66191b42442bc516caf8d3831555294",
"sha256": "f6e0e10810a96bf705993560822565d117ac288fecd34ffe1e32554dcd48839b"
},
"downloads": -1,
"filename": "open_forms_ext_haalcentraal_hr-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f66191b42442bc516caf8d3831555294",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12682,
"upload_time": "2024-03-26T16:32:46",
"upload_time_iso_8601": "2024-03-26T16:32:46.610945Z",
"url": "https://files.pythonhosted.org/packages/be/73/224d76d136413026146ccf9bceb91c6f75e2a2204fb0d50a21e59d75d48f/open_forms_ext_haalcentraal_hr-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4d7b25a60ec0217b21a74d71758c69736e1800e19f777beecda0a79ac0612324",
"md5": "472a845332a6f3672a417fd4e3b218c1",
"sha256": "60a3b763dacb75d030716d06c745825e4ffb4b71a0dc4f1ed688c3e156448401"
},
"downloads": -1,
"filename": "open-forms-ext-haalcentraal-hr-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "472a845332a6f3672a417fd4e3b218c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10031,
"upload_time": "2024-03-26T16:32:48",
"upload_time_iso_8601": "2024-03-26T16:32:48.787694Z",
"url": "https://files.pythonhosted.org/packages/4d/7b/25a60ec0217b21a74d71758c69736e1800e19f777beecda0a79ac0612324/open-forms-ext-haalcentraal-hr-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 16:32:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "open-formulieren",
"github_project": "open-forms-ext-haalcentraal-hr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "open-forms-ext-haalcentraal-hr"
}
JSON
