KP-APIs

Readme KP-APIs

Meer informatie over het Kennisplatform APIs is te vinden op de website van Geonovum. Hier vind je ook de mogelijkheid je aan te melden voor de werkgroepen, het slack kanaal en de nieuwsbrief.

De API strategie bestaat uit een een inleidend document, verschillende normatieve documenten (NL GOV standaarden) en meerdere modulen die voor verschillende functionele of technische situaties kunnen worden ingezet. Een actueel overzicht van alle documenten is weergegeven in de onderstaande infographic:

NL API Strategie Infographic

De verschillende onderdelen van de NL API Strategie bevat de volgende documenten:

Onderdeel Documentnaam & </br> Verwijzing naar de laatst gepubliceerde versie Status Versie
Algemeen Inleiding NL API Strategie Vastgesteld </br> (door Kennisplatform) 21-12-2023
Algemeen Architectuur NL API Strategie Vastgesteld </br> (door Kennisplatform) 21-12-2023
Algemeen Gebruikerswensen NL API Strategie Vastgesteld </br> (door Kennisplatform) 21-12-2023
Normatieve standaard API Design Rules (ADR) Verplicht </br> (pas toe leg uit) 09-07-2020 </br> v1.0.0
Normatieve standaard Open API Specification (OAS) Verplicht </br> (pas toe leg uit) 25-05-2018 </br> v3.0.0
Normatieve standaard NL GOV OAuth profiel Verplicht </br> (pas toe leg uit) 09-07-2020 </br> v1.0.0
Normatieve standaard NL GOV OpenID Connect profile Verplicht </br> (pas toe leg uit) 18-09-2023 </br> v1.0.1
Normatieve standaard Digikoppeling REST API koppelvlak specificatie Verplicht </br> (pas toe leg uit) 14-11-2022 </br> v1.1.1
Normatieve module API Geospatial Design Rules module Vastgesteld </br> (door Kennisplatform) </br> (door PGDI) 23-05-2023 </br> 07-03-2024
Normatieve module API Transport Security module Vastgesteld </br> (door Kennisplatform) </br> (door PGDI) 23-05-2023 </br> 07-03-2024
Aanvullende module API Access control module Stabiel </br> (Werkgroep Kennisplatform) 11-07-2023
Aanvullende module API Naming conventions module Stabiel </br> (Werkgroep Kennisplatform) 12-07-2023
Aanvullende module API Hypermedia module Stabiel </br> (Werkgroep Kennisplatform) 12-07-2023

Folders

De hoofdstructuur van de repository is aangepast !!!

Overzicht van de folders in de repository en het doel van de folder:

Nr Folder Doel
1 archief Parkeren en bewaren alle oude files en media die niet meer actief wordt gebruikt.
2 media Bron voor alle style sheets en media bestanden die in de tekst worden gebruikt. Zowel de bewerkbare bronbestanden als de gerenderde .svg, .png, .jpg bestanden worden in deze folder opgeslagen.
3 overleggen Hoofdmap voor alle werkmappen van de overleggen van de stuurgroep en werkgroepen.
3.1   /Stuurgroep Alle bestanden, verslagen en overige stukken van de stuurgroep.
3.2   /Werkgroep API architectuur Alle bestanden, verslagen en overige stukken van deze werkgroep.
3.3   /Werkgroep API beveiliging Alle bestanden, verslagen en overige stukken van deze werkgroep.
3.4   /Werkgroep API design rules Alle bestanden, verslagen en overige stukken van deze werkgroep.
3.5   /Werkgroep API design visie Alle bestanden, verslagen en overige stukken van deze werkgroep.
3.6   /Werkgroep API strategie en beleid Alle bestanden, verslagen en overige stukken van deze werkgroep.
4 API-strategie-algemeen Hoofdmap van de Algemene documenten van de API Strategie.
4.1   /Inleiding Map voor het eerste inhoudelijke en inleidende document
(wat iedereen moet lezen voor een algemeen beeld van de NL API Strategie.)
4.2   /Architectuur Map voor het architectuur document van de NL API Strategie.
Dit document is een verdieping van de inleiding. [ARC]
4.3   /Gebruikerswensen Map voor het document over gebruikerswensen en het bieden van een uitstekende developer experience. [DEX]
5 API-strategie-modules Hoofdmap voor alle modulen
5.1   /_extensies-legacy Map voor de verzameling van oude extenties. Deze map wordt verwijdert wanneer alle extenties zijn verwerkt tot modulen.
5.2   /_template Map voor de template die gebruikt kan worden voor nieuwe modulen
5.3   /access-control Map voor de module access control [ACC]
5.4   /geospatial Map voor de module geospatial [GEO]
5.5   /transport-security Map voor de module transport security [TRS]
     
6 API-strategie-governance Hoofdmap voor alle governance documenten en bestanden van het Kennisplatform APIs en de NL-API-Strategie