From 6e952ca36b4eff136eab39858418814a65197d00 Mon Sep 17 00:00:00 2001 From: Ruben van der Linde Date: Fri, 1 Dec 2023 12:05:10 +0100 Subject: [PATCH] Federatie nu ook uitgewerkt en beschreven --- docs/Architectuur.md | 17 +++++------------ docs/Federatie.puml | 25 +++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 12 deletions(-) create mode 100644 docs/Federatie.puml diff --git a/docs/Architectuur.md b/docs/Architectuur.md index f1100218..ca1cc535 100644 --- a/docs/Architectuur.md +++ b/docs/Architectuur.md @@ -76,25 +76,18 @@ De integratie voorziening "scraped" elke nacht alle relevante informatie en bouw Dit proces zorgt ervoor dat het zaaksysteem leidend is en dat zaken zowel kunnen worden gepubliceerd als gedepubliceerd. -## Federatie via OpenCatalogi +## Federatie (via OpenCatalogi) +OpenWoo.app maakt gebruik van het federatieve stelstel van [OpenCatalogi](https://opencatalogi.nl/) om verchillende integratie voorzieningne tesamen te binden. Hierbij verhoudt de organsiatie specifieke voorziening zich tot wat we binnen OPenCatalogi een catalogus noemen. +Dat betekend dat de integralle zoekvraag ook organisatie overstijgend kan worden gesteld aan meerdere organisatie tegelijktijd zonder dat er noodzaak is voor een landelijke index, dit concept is verder uitgewerkt in [koophulpje.nl](https://koophulpje.nl/) waarbij ook een voorziening is gerealiseerd voor het genereren van robot.txt en sitemap.xml bestanden. Defacto is hiermee dus ook een landerlijke WOO api gerealiseerd met die berpekend dat deze alleen organisaties bevat die participeren in OpenWoo.app -OpenWoo.app maakt gebruik van het federatieve stelstel van OpenCatalogi om de verschillende varianten te kunnen ontsluiten. Dit betekent dat organisaties zelf kunnen bepalen welke variant ze willen gebruiken en dat ze niet afhankelijk zijn van een centrale partij. - -## Landelijke API - -Iedereen kan de landelijke API bevragen om alle Woo-verzoeken en convenanten op te halen. De API is gebaseerd op de [NL API Strategie](https://docs.geostandaarden.nl/api/cv-hr-API-Strategie-20190213/). - -(wordt nog aangevuld) +De reden dat we hebben gekozen voor OpenCatalogi is dat in deze `variant` van FSC géén PKI of overige certificaten benodigd zijn. Dat lijnt uit met beter uit met de gedachte dat dit open data betreft die conform de wet juist annoniem toegankenlijk zou moeten zijn. +![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/Federatie.svg) ## Woo Publicatie Object Het Woo Publicatie Object vormt de kern van zowel de Woo API als de Woo-website. Dit object bevat alle essentiële informatie over een Woo-publicatie, inclusief metadata, publicatiedatum, bijlagen en andere relevante eigenschappen. Het dient als de centrale entiteit waaromheen de functionaliteiten van de API en de website zijn gebouwd. Door deze gecentraliseerde aanpak is het eenvoudiger om Woo-publicaties efficiënt te beheren, op te halen en weer te geven, en draagt het bij aan een coherente en gestroomlijnde gebruikerservaring. -Toegepaste norm: [NL API Strategie over property namen](https://docs.geostandaarden.nl/api/cv-hr-API-Strategie-20190213/#veldnamen-in-snake_case-camelcase-uppercamelcase-of-kebab-case) - - -Alle componenten worden getest met [zaaksysteem.nl](https://xxllnc.nl/zaakgericht/), Rx.Fundament en Decos JOIN ## Roadmap diff --git a/docs/Federatie.puml b/docs/Federatie.puml new file mode 100644 index 00000000..79fd62fd --- /dev/null +++ b/docs/Federatie.puml @@ -0,0 +1,25 @@ +@startuml +title Federatie + +' User Interface Component +interface "Landelijke API" as Api + +' Backend Components +component "NLX/FSC/FDS" as NLX +component "Intergratie voorziening Org 1" as Org1 +component "Intergratie voorziening Org 2" as Org2 +component "Intergratie voorziening Org 3" as Org3 +component "Bronnen" as BronnenOrg1 +component "Bronnen" as BronnenOrg2 +component "Bronnen" as BronnenOrg3 + +' Relationships +Api -down-> NLX : Connected trough outway +NLX -down-> Org1 : Connected trough inway +NLX -down-> Org2 : Connected trough inway +NLX -down-> Org3 : Connected trough inway +Org1 -down-> BronnenOrg1 : Internal connection +Org2 -down-> BronnenOrg2 : Internal connection +Org3 -down-> BronnenOrg3 : Internal connection + +@enduml \ No newline at end of file