✨ [#500] Implement Referentielijsten integration for Klantcontact

Author: OlhaZahoruiko

bin/docker_start.sh

@@ -21,7 +21,8 @@ until pg_isready; do
 done
 
 >&2 echo "Database is up."
-
+>&2 echo "Waiting 10 seconds for PostgreSQL initialization to complete..."
+sleep 10
 # Set defaults for OTEL
 export OTEL_SERVICE_NAME="${OTEL_SERVICE_NAME:-openklant}"
 

docker/referentielijsten/docker-compose.yml

@@ -0,0 +1,55 @@
+services:
+  referentielijsten-redis:
+    image: redis:7
+    command: ["redis-server", "--appendonly", "yes"]
+    networks:
+      - referentielijsten-dev
+
+  referentielijsten-db:
+    image: postgres:${PG_VERSION:-14}
+    environment:
+      - POSTGRES_HOST_AUTH_METHOD=trust
+      - POSTGRES_USER=referentielijsten
+      - POSTGRES_DB=referentielijsten
+    volumes:
+      - ./docker-init-referentielijsten-db/:/docker-entrypoint-initdb.d
+      - referentielijsten-db:/var/lib/postgresql/data
+    networks:
+      - referentielijsten-dev
+
+  referentielijsten-web.local:
+    image: maykinmedia/referentielijsten-api:${REFERENTIELIJSTEN_VERSION:-latest}
+    environment: &referentielijsten_web_env
+      - DJANGO_SETTINGS_MODULE=referentielijsten.conf.docker
+      - SECRET_KEY=${SECRET_KEY:-7&3f^bo1(-5($bre4iv-!nt%1xr!b54b&y7+97j5f&ndm_e=lz}
+      - ALLOWED_HOSTS=referentielijsten-web.local,localhost
+      - DB_NAME=referentielijsten
+      - DB_USER=referentielijsten
+      - DB_HOST=referentielijsten-db
+      - DISABLE_2FA=true
+      - IS_HTTPS=no
+      - CACHE_DEFAULT=referentielijsten-redis:6379/0
+      - CACHE_AXES=referentielijsten-redis:6379/0
+      - SUBPATH=${SUBPATH:-/}
+      - DJANGO_SUPERUSER_PASSWORD=admin
+    ports:
+      - 8004:8000
+    volumes: &referentielijsten_web_volumes
+      # mount fixtures dir to automatically populate the DB
+      - ./fixtures/:/app/fixtures
+      - media:/app/media  # Shared media volume to get access to saved OAS files
+      - private-media:/app/private-media
+    depends_on:
+      - referentielijsten-db
+      - referentielijsten-redis
+    networks:
+      - referentielijsten-dev
+
+volumes:
+  referentielijsten-db:
+  media:
+  private-media:
+
+networks:
+  referentielijsten-dev:
+    name: referentielijsten-dev

docker/referentielijsten/docker-init-referentielijsten-db/0001-docker-init-referentielijsten-db.sql

@@ -0,0 +1,5 @@
+CREATE USER referentielijsten;
+CREATE DATABASE referentielijsten;
+GRANT ALL PRIVILEGES ON DATABASE referentielijsten TO referentielijsten;
+-- On Postgres 15+, connect to the database and grant schema permissions.
+-- GRANT USAGE, CREATE ON SCHEMA public TO referentielijsten;

docker/referentielijsten/fixtures/referentielijsten_fixtures.json

@@ -0,0 +1,39 @@
+[
+{
+    "model": "api.tabel",
+    "pk": 1,
+    "fields": {
+        "code": "TEST",
+        "naam": "Test Tabel",
+        "einddatum_geldigheid": null,
+        "beheerder_naam": "Mary",
+        "beheerder_email": "[email protected]",
+        "beheerder_afdeling": "",
+        "beheerder_organisatie": ""
+    }
+},
+{
+    "model": "api.item",
+    "pk": 1,
+    "fields": {
+        "tabel": 1,
+        "code": "ITEM001",
+        "naam": "Test Item 1",
+        "begindatum_geldigheid": "2025-10-27T15:09:23Z",
+        "einddatum_geldigheid": null,
+        "aanvullende_gegevens": null
+    }
+},
+{
+    "model": "api.item",
+    "pk": 2,
+    "fields": {
+        "tabel": 1,
+        "code": "ITEM002",
+        "naam": "Test Item 2",
+        "begindatum_geldigheid": "2025-10-27T15:09:07Z",
+        "einddatum_geldigheid": "2026-10-27T15:09:08Z",
+        "aanvullende_gegevens": null
+    }
+}
+]

migration/cassettes/test_digitaal_adres.yaml

@@ -35,4 +35,4 @@ interactions:
     status:
       code: 200
       message: OK
-version: 1
+version: 1

src/openklant/components/klantinteracties/api/serializers/klantcontacten.py

@@ -18,6 +18,7 @@
 )
 from openklant.components.klantinteracties.api.validators import (
     FKUniqueTogetherValidator,
+    KanaalValidator,
     betrokkene_exists,
     bijlage_exists,
     klantcontact_exists,
@@ -306,6 +307,12 @@ class KlantcontactSerializer(serializers.HyperlinkedModelSerializer):
         "had_betrokkenen.digitale_adressen": f"{SERIALIZER_PATH}.digitaal_adres.DigitaalAdresSerializer",
     }
 
+    kanaal = serializers.CharField(
+        max_length=50,
+        help_text=_("Communicatiekanaal dat bij het klantcontact werd gebruikt."),
+        validators=[KanaalValidator()],
+    )
+
     class Meta:
         model = Klantcontact
         fields = (

src/openklant/components/klantinteracties/api/validators.py

@@ -1,9 +1,12 @@
+from django.core.exceptions import ValidationError
 from django.core.validators import EmailValidator
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
+import structlog
 from rest_framework import serializers
 from rest_framework.validators import UniqueTogetherValidator, qs_filter
+from zgw_consumers.client import build_client
 
 from openklant.components.klantinteracties.constants import SoortDigitaalAdres
 from openklant.components.klantinteracties.models.actoren import Actor
@@ -25,7 +28,11 @@
     PartijIdentificator,
 )
 from openklant.components.klantinteracties.models.rekeningnummers import Rekeningnummer
+from openklant.config.models import ReferentielijstenConfig
 from openklant.utils.validators import validate_phone_number
+from referentielijsten_client.client import ReferentielijstenClient
+
+logger = structlog.get_logger(__name__)
 
 
 class FKUniqueTogetherValidator(UniqueTogetherValidator):
@@ -180,3 +187,28 @@ def __call__(self, soort_digitaal_adres: SoortDigitaalAdres, value: str):
                 validate_phone_number(value)
             case _:
                 return
+
+
+class KanaalValidator:
+    def __call__(self, value: str):
+        config = ReferentielijstenConfig.get_solo()
+        if not config.enabled:
+            return value
+
+        if not config.service:
+            logger.warning("missing_referentielijsten_service")
+            return value
+
+        client = build_client(
+            service=config.service,
+            client_factory=ReferentielijstenClient,
+        )
+        kanalen_data = client.get_cached_items_by_tabel_code(config.tabel_code)
+        kanalen = [item["code"] for item in kanalen_data if "code" in item]
+
+        if value not in kanalen:
+            raise ValidationError(
+                f"'{value}' is not a valid kanaal. Allowed values: {', '.join(kanalen)}"
+            )
+
+        return value

src/openklant/conf/base.py

@@ -25,6 +25,7 @@
     "openklant.components.token",
     "openklant.components.klantinteracties",
     "openklant.components.contactgegevens",
+    "openklant.config",
     # Django libraries
     "localflavor",
 ]