diff --git a/docs/Architectuur.md b/docs/Architectuur.md index 8c4f13ab..b336547c 100644 --- a/docs/Architectuur.md +++ b/docs/Architectuur.md @@ -4,6 +4,10 @@ OpenWoo.app bestaat in essentie uit een aantal componenten die samenwerken rondom een integratievoorziening, het lijnt daarmee uit met de lagen architectuur van Common Ground. Daarbij is de keuze aan de ontsluitende overheid welke componenten van welke leveranciers zij inzet. Het is daarmee bewust de bedoeling dat de inrichting per overheid kan verschillen, zodat deze beter in het landschap van die betreffende overheid past. Binnen de OpenWoo.app kennen we momenteel de volgende componenten: +> **Hulp nodig?** +> +> Hiervoor hebben we een appart [slack kanaal](https://samenorganiseren.slack.com/archives/C067Q3UE9F0) binnen commonground. We helpen je daar graag verder. + ### Open Webconcept-variant zonder integratie Met deze variant kunnen Woo-verzoeken en convenanten eenvoudig worden beheerd vanuit de bestaande webomgeving en CMS . Dit vereist geen extra installatie of beheerinspanningen van de organisatie, op voorwaarde dat er al een OpenWebconcept-installatie met de benodigde plugins beschikbaar is. diff --git a/docs/Integratie.md b/docs/Integratie.md index 81c67916..5bac862f 100644 --- a/docs/Integratie.md +++ b/docs/Integratie.md @@ -8,20 +8,17 @@ OpenWoo.app is essentie een koppelvlak waar aan de bovenkant meerdere weergaven ## Het koppelen van een user interface -Als u als organisatie of leverancier OpenWoo.app wilt koppelen aan een huidige interface (bijvoorbeeld door de resultaten uit uw gemeente in uw website te integereren) and kunt u daarvoor gebruikmaken van de OpenWoo.app API. +Als u als organisatie of leverancier OpenWoo.app wilt koppelen aan een huidige interface (bijvoorbeeld door de resultaten uit uw gemeente in uw website te integereren) and kunt u daarvoor gebruikmaken van de OpenWoo.app API. ### Locatie en Authenticatie U vindt de API op [https://api.gateway.commonground.nu/api/publicaties](https://api.gateway.commonground.nu/api/publicaties). Voor het stellen van zoekvragen is géén authenticatie vereist (het doel van OpenWOO.app is immers het verspreiden van openbare informatie). Er is echter wel sprake van throttling op response tijden (de API reageert langzamer) en rate-limiting (het aantal bevragingen per minuut en uur zijn beperkt) zonder authenticatie. Ook zijn alleen de GET (ophalen) acties toegestaan zonder authenticatie. -Als u vanuit uw casus een API nodig heeft zonder throttling, ratelimit of namens een organisatie wijzigingen wilt doen (POST,PUT,DELETE) dan zijn er twee mogelijkheden. - -- Beschikt uw organisatie reeds over FSC? Dan kunt u ons via FSC toegangsverzoek doen -- Beschikt uw organisatie nog niet over FSC? Dan kunt u een mail sturen naar +Als u vanuit uw casus een API nodig heeft zonder throttling, ratelimit of namens een organisatie wijzigingen wilt doen (POST,PUT,DELETE) dan kunt u een mail sturen naar . ### Documentatie -Voor de API is een [redoc documentatie]() beschikbaar met voorbeelden van de verschillende API endpoints, calls en resultaten. Omdat de API daarnaast kan worden gebruikt zonder authenticatie is deze ook goed te beproeven via onze [Postman collectie](). We raden developers van ook van harte aan om aan de hand van deze collectie te spelen en ontwikkelen. +Voor de API is een [redoc documentatie](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/oas.yaml) beschikbaar met voorbeelden van de verschillende API endpoints, calls en resultaten. Omdat de API daarnaast kan worden gebruikt zonder authenticatie is deze ook goed te beproeven via onze [Postman collectie](). We raden developers van ook van harte aan om aan de hand van deze collectie te spelen en ontwikkelen. ### Voorbeelden @@ -41,53 +38,6 @@ Response "results": [ { "_id": "3c75db6d-55b5-48da-aef8-a5768dd8ec89", - "_self": { - "id": "3c75db6d-55b5-48da-aef8-a5768dd8ec89", - "name": "Afvalwaterakkoord", - "self": "/api/openWOO/3c75db6d-55b5-48da-aef8-a5768dd8ec89", - "schema": { - "id": "b405e7bf-6d6a-41d6-8db2-9a2a639cbd1e", - "name": "OpenWOO", - "ref": "https://commongateway.nl/pdd.openWOO.schema.json" - }, - "level": 1, - "dateCreated": "2023-11-24T11:31:47+00:00", - "dateModified": "2023-11-24T11:31:48+00:00", - "owner": { - "id": "f5d48e83-7a82-4d42-9120-9ff7b1ba0129", - "name": "Conduction Admin", - "ref": "https://docs.commongateway.nl/user/default.user.json" - }, - "organization": { - "id": "a1c8e0b6-2f78-480d-a9fb-9792142f4761", - "name": "Default Organization", - "ref": "https://docs.commongateway.nl/organization/default.organization.json" - }, - "application": { - "id": null, - "name": null, - "ref": null - }, - "synchronizations": [ - { - "id": "e0d1d582-86b9-469a-9494-526b34b2ab41", - "source": { - "id": "75b9d330-a87b-477e-a6e0-8258ecc75c97", - "ref": "https://commongateway.woo.nl/source/ridderkerk.openwoo.source.json", - "name": "Ridderkerk OpenWoo", - "description": "Ridderkerk OpenWoo API", - "location": "https://openpub.ridderkerk.nl/wp-json" - }, - "endpoint": null, - "sourceId": "12202548", - "dateCreated": "2023-11-24T11:31:47+00:00", - "dateModified": "2023-11-24T11:31:48+00:00", - "lastChecked": null, - "lastSynced": null, - "sourceLastChanged": null - } - ] - }, "id": "3082", "titel": "Afvalwaterakkoord", "beschrijving": null, @@ -96,54 +46,7 @@ Response "publicatiedatum": "2023-11-24 11:31:47", "portalUrl": "https://conductionnl.github.io/woo-website-epe/19cdec3f-896f-4765-8d62-c6c8570926b7", "bijlagen": [ - { - "_self": { - "id": "2653c850-a57f-49ef-80e4-89b8d445a98a", - "name": "Naam_Bijlage", - "self": "/api/bijlagen/2653c850-a57f-49ef-80e4-89b8d445a98a", - "schema": { - "id": "bbfc722b-55bb-455e-8029-4b5bee6172e4", - "name": "Bijlage", - "ref": "https://commongateway.nl/pdd.bijlage.schema.json" - }, - "level": 2, - "dateCreated": "2023-11-24T11:31:47+00:00", - "dateModified": "2023-11-24T11:31:48+00:00", - "owner": { - "id": "f5d48e83-7a82-4d42-9120-9ff7b1ba0129", - "name": "Conduction Admin", - "ref": "https://docs.commongateway.nl/user/default.user.json" - }, - "organization": { - "id": "a1c8e0b6-2f78-480d-a9fb-9792142f4761", - "name": "Default Organization", - "ref": "https://docs.commongateway.nl/organization/default.organization.json" - }, - "application": { - "id": null, - "name": null, - "ref": null - }, - "synchronizations": [ - { - "id": "f8cbb0d0-aa58-4163-97f2-2da2a220bb31", - "source": { - "id": "75b9d330-a87b-477e-a6e0-8258ecc75c97", - "ref": "https://commongateway.woo.nl/source/ridderkerk.openwoo.source.json", - "name": "Ridderkerk OpenWoo", - "description": "Ridderkerk OpenWoo API", - "location": "https://openpub.ridderkerk.nl/wp-json" - }, - "endpoint": null, - "sourceId": "https://openpub.ridderkerk.nl/wp-content/uploads/sites/3/2023/02/ondertekend-afvalwaterakkoord-Ridderkerk-2022.pdf", - "dateCreated": "2023-11-24T11:31:47+00:00", - "dateModified": "2023-11-24T11:31:47+00:00", - "lastChecked": null, - "lastSynced": null, - "sourceLastChanged": null - } - ] - }, + { "id": null, "titel": "Naam_Bijlage", "categorie": null, @@ -154,70 +57,12 @@ Response ], "themas": [ { - "_self": { - "id": "622721fc-6866-4a88-a1da-91a28edbcb39", - "name": "No name could be established for this entity", - "self": "/api/themas/622721fc-6866-4a88-a1da-91a28edbcb39", - "schema": { - "id": "df8dec18-b872-4052-a9c4-d25d0654299e", - "name": "Thema", - "ref": "https://commongateway.nl/pdd.thema.schema.json" - }, - "level": 2, - "dateCreated": "2023-11-24T11:31:47+00:00", - "dateModified": "2023-11-24T11:31:48+00:00", - "owner": { - "id": "f5d48e83-7a82-4d42-9120-9ff7b1ba0129", - "name": "Conduction Admin", - "ref": "https://docs.commongateway.nl/user/default.user.json" - }, - "organization": { - "id": "a1c8e0b6-2f78-480d-a9fb-9792142f4761", - "name": "Default Organization", - "ref": "https://docs.commongateway.nl/organization/default.organization.json" - }, - "application": { - "id": null, - "name": null, - "ref": null - }, - "synchronizations": null - }, "hoofdthema": "Milieu", "subthema": null, "aanvullendThema": null } ], "organisatie": { - "_self": { - "id": "37165afb-0e33-4813-8f66-d504501e6128", - "name": "Gemeente Ridderkerk", - "self": "/api/organisatie/37165afb-0e33-4813-8f66-d504501e6128", - "schema": { - "id": "c58c5089-924a-45de-90d2-5a04707dd3aa", - "name": "Organisatie", - "ref": "https://commongateway.nl/woo.organisatie.schema.json" - }, - "level": 2, - "dateCreated": "2023-11-24T11:31:47+00:00", - "dateModified": "2023-11-24T11:31:48+00:00", - "owner": { - "id": "f5d48e83-7a82-4d42-9120-9ff7b1ba0129", - "name": "Conduction Admin", - "ref": "https://docs.commongateway.nl/user/default.user.json" - }, - "organization": { - "id": "a1c8e0b6-2f78-480d-a9fb-9792142f4761", - "name": "Default Organization", - "ref": "https://docs.commongateway.nl/organization/default.organization.json" - }, - "application": { - "id": null, - "name": null, - "ref": null - }, - "synchronizations": null - }, "naam": "Gemeente Ridderkerk", "rsin": null, "tooi": null, @@ -225,67 +70,9 @@ Response "id": "37165afb-0e33-4813-8f66-d504501e6128" }, "metadata": { - "_self": { - "id": "8e1084b5-ba4d-4d33-a5c2-f98e7f893f07", - "name": "No name could be established for this entity", - "self": "/api/metadata/8e1084b5-ba4d-4d33-a5c2-f98e7f893f07", - "schema": { - "id": "dc551296-2715-4316-bb43-8a814f50197a", - "name": "Metadata", - "ref": "https://commongateway.nl/woo.metadata.schema.json" - }, - "level": 2, - "dateCreated": "2023-11-24T11:31:47+00:00", - "dateModified": "2023-11-24T11:31:48+00:00", - "owner": { - "id": "f5d48e83-7a82-4d42-9120-9ff7b1ba0129", - "name": "Conduction Admin", - "ref": "https://docs.commongateway.nl/user/default.user.json" - }, - "organization": { - "id": "a1c8e0b6-2f78-480d-a9fb-9792142f4761", - "name": "Default Organization", - "ref": "https://docs.commongateway.nl/organization/default.organization.json" - }, - "application": { - "id": null, - "name": null, - "ref": null - }, - "synchronizations": null - }, "volgnummer": null, "besluitdatum": "2022-12-21", "verzoek": { - "_self": { - "id": "865e9591-109c-40f0-abb6-617f24893e10", - "name": "No name could be established for this entity", - "self": "/api/objects/865e9591-109c-40f0-abb6-617f24893e10", - "schema": { - "id": "8eafc709-09a5-4e71-9f4a-2831db244f5f", - "name": "Verzoek", - "ref": "https://commongateway.nl/woo.verzoek.schema.json" - }, - "level": 3, - "dateCreated": "2023-11-29T18:56:18+00:00", - "dateModified": "2023-11-29T19:10:18+00:00", - "owner": { - "id": "b5d1f8b2-100a-4925-9faa-f0a435228ee6", - "name": "Default User", - "ref": "https://docs.commongateway.nl/user/default.user.json" - }, - "organization": { - "id": "a1c8e0b6-2f78-480d-a9fb-9792142f4761", - "name": "Default Organization", - "ref": "https://docs.commongateway.nl/organization/default.organization.json" - }, - "application": { - "id": null, - "name": null, - "ref": null - }, - "synchronizations": null - }, "inventarisatielijst": { "_self": { "id": "c9517757-a726-4aec-b666-6ae5d21281ee", @@ -342,53 +129,6 @@ Response "id": null }, "informatieverzoek": { - "_self": { - "id": "f6395c55-56d6-4837-bbd2-4e3f57f66f2a", - "name": "Temporarily title so a object gets created for file fetching and url genering.", - "self": "/api/bijlagen/f6395c55-56d6-4837-bbd2-4e3f57f66f2a", - "schema": { - "id": "fb4325dc-5f4e-4336-b2b5-f4c5f0872596", - "name": "Bijlage", - "ref": "https://commongateway.nl/woo.bijlage.schema.json" - }, - "level": 3, - "dateCreated": "2023-11-29T18:56:16+00:00", - "dateModified": "2023-11-29T19:10:18+00:00", - "owner": { - "id": "b5d1f8b2-100a-4925-9faa-f0a435228ee6", - "name": "Default User", - "ref": "https://docs.commongateway.nl/user/default.user.json" - }, - "organization": { - "id": "a1c8e0b6-2f78-480d-a9fb-9792142f4761", - "name": "Default Organization", - "ref": "https://docs.commongateway.nl/organization/default.organization.json" - }, - "application": { - "id": null, - "name": null, - "ref": null - }, - "synchronizations": [ - { - "id": "83fbd5dc-50f0-4c83-a0b3-1c9d097bc27c", - "source": { - "id": "b4857337-cd1b-4834-9aeb-193c7170c488", - "ref": "https://commongateway.woo.nl/source/epe.zaaksysteem.source.json", - "name": "Epe zaaksysteem", - "description": "Epe zaaksysteem api", - "location": "https://zaaksysteem-accept.epe.nl/api" - }, - "endpoint": null, - "sourceId": "348048f9-b29f-4986-8709-687d70d52333", - "dateCreated": "2023-11-29T18:56:16+00:00", - "dateModified": "2023-11-29T18:56:16+00:00", - "lastChecked": null, - "lastSynced": null, - "sourceLastChanged": null - } - ] - }, "categorie": null, "type": null, "status": "accepted", @@ -397,53 +137,6 @@ Response "id": null }, "besluit": { - "_self": { - "id": "c070e255-bb45-424c-aafd-53b885c4c144", - "name": "Temporarily title so a object gets created for file fetching and url genering.", - "self": "/api/bijlagen/c070e255-bb45-424c-aafd-53b885c4c144", - "schema": { - "id": "fb4325dc-5f4e-4336-b2b5-f4c5f0872596", - "name": "Bijlage", - "ref": "https://commongateway.nl/woo.bijlage.schema.json" - }, - "level": 3, - "dateCreated": "2023-11-29T18:56:17+00:00", - "dateModified": "2023-11-29T19:10:18+00:00", - "owner": { - "id": "b5d1f8b2-100a-4925-9faa-f0a435228ee6", - "name": "Default User", - "ref": "https://docs.commongateway.nl/user/default.user.json" - }, - "organization": { - "id": "a1c8e0b6-2f78-480d-a9fb-9792142f4761", - "name": "Default Organization", - "ref": "https://docs.commongateway.nl/organization/default.organization.json" - }, - "application": { - "id": null, - "name": null, - "ref": null - }, - "synchronizations": [ - { - "id": "14be2af7-bb74-4f38-8b7a-dcc1844bff60", - "source": { - "id": "b4857337-cd1b-4834-9aeb-193c7170c488", - "ref": "https://commongateway.woo.nl/source/epe.zaaksysteem.source.json", - "name": "Epe zaaksysteem", - "description": "Epe zaaksysteem api", - "location": "https://zaaksysteem-accept.epe.nl/api" - }, - "endpoint": null, - "sourceId": "160ce4f7-612d-4ffa-a504-51b78367c61f", - "dateCreated": "2023-11-29T18:56:17+00:00", - "dateModified": "2023-11-29T18:56:17+00:00", - "lastChecked": null, - "lastSynced": null, - "sourceLastChanged": null - } - ] - }, "categorie": null, "type": null, "status": "accepted",