Dit Hoofdstuk geeft een inleiding op de Nederlandse API strategie. De stategie is opgebouwd uit meerdere documenten, standaarden en modulen. De NL API Strategie wordt doorontwikkeld en beheerd door het Kennisplatform API's.
Op GitHub kan bekeken worden wat de actuele ontwikkelingen zijn met betrekking tot de Nederlandse API strategie.
Er worden slechts een beperkt aantal auteurs genoemd, echter aan deze strategie is door veel meer mensen gewerkt. Per onderdeel van de API strategie staan de degene verantwoordelijk voor de laatste versie vermeld. De genoemde auteurs zijn deelnemers aan de relevante werkgroep van het Kennisplatform API's zoals: API Strategie, Architectuur, Security, Design Rules, Authenticatie en Autorisatie, Strategie en Beleid, en Gebruikerswensen.
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 InfographicDe verschillende onderdelen van de NL API Strategie bevat de volgende documenten:
| Onderdeel | Documentnaam & Verwijzing naar de gepubliceerde versie |
Status | Versie |
|---|---|---|---|
| Algemeen | Inleiding NL API Strategie | Vastgesteld (door Kennisplatform) |
08-03-2024 |
| Algemeen | Architectuur NL API Strategie | Vastgesteld (door Kennisplatform) |
08-03-2024 |
| Algemeen | Gebruikerswensen NL API Strategie | Vastgesteld (door Kennisplatform) |
08-03-2024 |
| Normatieve standaard | API Design Rules (ADR) | Verplicht (pas toe leg uit) |
09-07-2020 v1.0.0 |
| Normatieve standaard | API Design Rules (ADR) | Verplicht * (door MIDO) |
08-03-2024 v2.0.0 |
| Verplichte standaard | Open API Specification (OAS) | Verplicht (pas toe leg uit) |
25-05-2018 v3.0.0 |
| Normatieve standaard | NL GOV OAuth profiel | Verplicht (pas toe leg uit) |
09-07-2020 v1.0.0 |
| Verplichte standaard | NL GOV OpenID Connect profile | Verplicht (pas toe leg uit) |
18-02-2021 v1.0.0 |
| Verplichte standaard | Digikoppeling REST API koppelvlak specificatie | Verplicht (pas toe leg uit) |
14-11-2022 v1.1.1 |
| Normatieve standaard | API Geospatial module | Verplicht * (door MIDO) |
08-03-2024 |
| Normatieve standaard | API Transport Security module | Verplicht * (door MIDO) |
08-03-2024 |
| Aanvullende module | API Access control module | Vastgesteld (door Kennisplatform) |
08-03-2024 |
| Aanvullende module | API Naming conventions module | Vastgesteld (door Kennisplatform) |
08-03-2024 |
| Aanvullende module | API Hypermedia module | Stabiel (Werkgroep Kennisplatform) |
12-07-2023 |
| Aanvullende module | API Batching module | Concept (Werkgroep Kennisplatform) |
- Deze modules zijn normatief binnen de GDI, vaststellingsproces pas toe of leg uit lijst is nog in procedure