REST-API Design Rules
- Onderdeel van
- Lijsten & Verwijzingen
- Contact
- NORA Beheer
- nora@ictu.nl
- Status
- Actueel
- Status is afgeleid van Status bij Forum Standaardisatie (Verplicht (pas toe leg uit))
- Naam
- REST-API Design Rules
- ID
- Type
- Wijzigingsdatum
Schaduwkopie: fs:rest-api-design-rules
- 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 Digitaal Stelsel Omgevingswet.
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 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 met 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 10 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 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 REST-API Design Rules moeten 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.
- Status op lijst van Forum Standaardisatie: Verplicht (pas toe leg uit)
Waar toepasbaar
- Functioneel toepassingsgebied: De standaard 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:
Meer informatie
- https://gitdocumentatie.logius.nl/publicatie/api/adr/1.0/
- Beheerorganisatie: Logius
Realiseert
Lijst Open Standaarden voor Pas Toe of Leg UitToepassing in voorzieningen en bouwstenen
| Voorziening | Toelichting | Oordeel | Relevantie | Volgens bron | Gepubliceerd op |
|---|---|---|---|---|---|
| BAG (Basisregistratie Adressen en Gebouwen) BRK (Basisregistratie Kadaster) BGT (Basisregistratie Grootschalige Topografie) WOZ (Basisregistratie Waarde Onroerende Zaken) BRT (Basisregistratie Topografie) | voldoet | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 | |
| BRO (Basisregistratie Ondergrond) | De BRO is compliant aan deze standaard. Dit geldt overigens voor alle API’s behalve de REST-API op het bronhouderportaal. Hier is een update gepland. | voldoet deels | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |
| BRV (Basisregistratie Voertuigen) | voldoet | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 | |
| HR (Basisregistratie Handelsregister) | KVK hanteert de REST-API Design rules al geruime tijd, inmiddels zijn ook “oudere” API’s in het kader van doorontwikkeling aangepast aan deze regels. | voldoet | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |
| MijnOverheid | Er is een initiatief gestart (reeds lopend) om de bestaande en nieuwe API’s van MijnOverheid te laten voldoen aan de benodigde specificaties/standaarden. Dit probleem wordt dus binnen een aanzienlijk korte termijn opgelost. | gepland | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |
| Ondernemersplein | Voor Ondernemersplein API´s zijn de REST-API Design Rules voor zover mogelijk toegepast. | voldoet | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |
| Samenwerkende catalogi | Er heeft tot nu toe geen vernieuwing op de API plaatsgevonden waarin dit kon worden meegenomen. | voldoet niet | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |
| Stelselcatalogus | De Stelselcatalogus voldoet aan de RESTAPI design rules. Hier staat hij conform deze standaard beschreven: https://stelselcatalogus.nl/api/v2 | voldoet | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |
| Website RDW.nl | De bestaande REST-API’s zijn niet tegen de REST-API Design Rules aangehouden. | voldoet niet | van toepassing | Monitor Open Standaarden 2022 | 18 november 2022 |
| Beheervoorziening BSN BRP-V (BRP Verstrekkingsvoorziening) | De BRP voldoet niet aan de REST-API Design Rules standaard. De BVBSN voldoet wel aan de REST-API Design Rules standaard. | voldoet deels | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |
| Overheid.nl | Overheid.nl is niet de authentieke bron van de content/data die op het portaal wordt ontsloten en biedt daarom geen eigen API aan voor ontsluiting van deze content. Overheid.nl maakt derhalve gebruik van de API’s van de achterliggende authentieke bronnen om content te publiceren op het portaal. | voldoet niet | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |
| PDOK | De vernieuwde OGC-API’s voldoen op één paar kleine issues aan deze regels: https://api.pdok.nl/lv/bgt/ogc/v1_0. Eén issue wordt binnenkort opgelost (versie 1_0 wordt v1). Ander issue wordt teruggekoppeld (i.v.m. twijfels over de regel). PDOK wil in de toekomst zo veel mogelijk datasets via de OGC API’s beschikbaar gaan stellen. | voldoet deels | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |
| TenderNed | De REST-API’s die worden gebruikt, voldoen aan de design rules. | voldoet | van toepassing | Monitor Open Standaarden 2024 | 20 september 2024 |