REST-API Design Rules
Beschrijving
NLGov REST API Design Rules is een lijst afspraken die ontwikkelaars volgen tijdens het bouwen van een REST-API voor de publieke sector. Door de regels te hanteren wordt de API voorspelbaar. En dat is wel zo prettig voor andere ontwikkelaars die er gebruik van willen maken. Dankzij deze regels blijft het makkelijk voor organisaties om gegevens met elkaar uit te wisselen.
Status
| Lijst status | Verplicht ('Pas toe of leg uit') |
|---|---|
| Functioneel toepassingsgebied | De standaard NLGov REST API Design Rules moet worden toegepast bij het aanbieden van REST API’s ten behoeve van het ontsluiten van overheidsinformatie en/of functionaliteit. |
| Organisatorisch werkingsgebied | Nederlandse overheden (Rijk, provincies, gemeenten en waterschappen) en instellingen uit de (semi-) publieke sector. |
| Aanvullende verplichtingen | |
| Europese status (MSP) | Nee |
Nut en werking
| Typering | Verzameling regels voor het structureren en documenteren van REST API’s |
|---|---|
| Nut | De overheid ontsluit gegevens en applicaties steeds vaker met REST-API's. Voorbeelden hiervan zijn te zien op de website developer.overheid.nl, in Common Ground, Haal Centraal en het Informatiepunt Leefomgeving.
Representational state transfer (REST) is een ontwerpprincipe dat wereldwijd veel gebruikt wordt voor het bouwen van programmeerinterfaces over het web (API's). REST is geen standaard maar een ontwerpprincipe, en laat nog veel vrijheid in het structureren van API's. De standaard NLGov REST API Design Rules geeft een verzameling basisregels voor structuur en naamgeving waarmee de overheid op een uniforme en eenduidige manier REST-API's aanbiedt. Dit maakt het voor ontwikkelaars gemakkelijker om betrouwbare applicaties te ontwikkelen met API's van de overheid. |
| Werking | Een application programming interface (API) is een gestructureerd en gedocumenteerd koppelvlak voor communicatie tussen applicaties. Zo lang er computers zijn, bestaan er API's en worden er verschillende API technologieën gebruikt. In de laatste tien jaar heeft Representational state transfer (REST) zich ontwikkeld tot een bepalend principe voor het realiseren van API's. Zogenaamde ‘REST-API's’ doen voor applicaties wat websites voor mensen doen. Websites presenteren informatie aan mensen, REST-API's maken applicaties en gegevens over het Internet beschikbaar voor andere applicaties. De technologie achter websites en REST-API's heeft daarom veel gemeen.
De overheid gebruikt REST-API's voor koppelingen met andere overheden, bedrijven en indirect ook met burgers, bijvoorbeeld via mobiele apps en webapps die aangeboden worden door bedrijven of overheden zelf. Ontwikkelaars kunnen deze REST-API's bevragen vanuit de gangbare programmeertalen en frameworks zoals Python, Java, Microsoft C#, PHP. De standaard NLGov REST API Design Rules heeft tot doel om meer uniformiteit te brengen in de manier waarop de overheid REST-API's aanbiedt. Hiervoor beschrijft de standaard een aantal basisregels voor het structureren en documenteren van REST-API's. De standaard NLGov REST API Design Rules moet toegepast worden daar waar de overheid REST-API's inzet, maar verplicht niet het gebruik van REST-API's bij het ontsluiten van gegevens of functionaliteit. |
| Relatie met andere FS-Standaarden | |
| Domein | |
| Trefwoorden | Informatiebeveiliging |
| Gangbaar |
Detailinformatie
| Volledige naam | NLGov REST API Design Rules |
|---|---|
| Versie | 2.1 |
| Specificatiedocument | https://gitdocumentatie.logius.nl/publicatie/api/adr/2.1.0/ |
| Beheerorganisatie | Logius |
Toepassing
| Community | |
|---|---|
| Implementatiehulpmiddelen | |
| Conformiteitstest | Gebruikers kunnen de conformiteit van de implementatie van de standaardtoetsen via developer.overheid.nl (centrale plek voor developers die voor of met de overheid ontwikkelen). |
| Praktijkvoorbeelden | * Kadaster: Kadaster Dataplatform, het platform met betrouwbare geodata |
Toetsingsinformatie
| Toelichting bij opname lijst Forum Standaardisatie | === De standaard verplicht niet het gebruik van REST-API's ===
Als een overheidsorganisatie investeert in de bouw van REST-API's, dan moeten deze aangeboden worden volgens de REST-API design rules. De standaard zelf verplicht echter niet het gebruik van REST-API's om gegevens of functionaliteit te ontsluiten. Hiervoor kunnen als vanouds ook Webservices (SOAP-API's), (linked) open data of andere koppelvlakken gebruikt worden. Beheer onder LogiusDe standaard NLGov REST API Design Rules is ontwikkeld in het Kennisplatform API's door een brede groep organisaties. Vanaf medio 2020 ligt het beheer van de standaard formeel bij Logius. Het Kennisplatform API's blijft wel input leveren voor de doorontwikkeling van de standaard. Veranderend gegevenslandschapDe groeiende inzet van REST-API's bij de overheid raakt bestaande standaarden zoals Digikoppeling en StUF. Logius, VNG, Forum Standaardisatie en het Kennisplatform API's werken samen aan een visie over de transitie naar een nieuw gegevenslandschap en hoe REST-API's, Digikoppeling en StUF daarin samenhangen. Hierover volgt nog een publicatie. |
|---|---|
| Adoptieadviezen | * Aan Forum Standaardisatie om duidelijkheid te geven over de samenhang tussen verschillende standaarden –met name de samenhang tussen StUF en standaarden gerelateerd aan API’s– eventueel door het publiceren van een beslisboom.
|
| Uitstekend beheer | Ja |
| Aanmelder | |
| Documentatie voor opname lijst Forum Standaardisatie | |
| Datum van aanmelding | 2019-10-15 |
| Datum van besluit OBDO | 2020-07-09 |
Overig
| Waarvoor geldt de verplichting | |
|---|---|
| Toelichting relatie met andere FS-standaarden | |
| Aandachtspunten | |
| Advies aan beheerder | |
| Sjabloon-bestektekst | |
| CPV-code(s) | |
| Leveranciers |
Documentatie
25 februari 2020 12:07:39
10 april 2026 10:01:33
43
Informatief
