REST-API Design Rules

Standaarden

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

Standaard

Wijzigingsdatum

Deze informatie is (deels) overgenomen van forumstandaardisatie.nl.
Schaduwkopie: fs:rest-api-design-rules

Alle eigenschappen

Inhoud Standaarden

• Standaarden
  • Beleid en praktijk rond standaarden op noraonline
• Alle standaarden
  • Lijst Pas Toe of Leg Uit Standaarden
  • Lijst Aanbevolen Standaarden
  • Overige standaarden
• Standaarden internationaal

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 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://publicatie.centrumvoorstandaarden.nl/api/adr/
• Beheerorganisatie: Logius

Realiseert

Lijst Open Standaarden voor Pas Toe of Leg Uit

Toepassing in voorzieningen en bouwstenen

Voorziening	Toelichting	Oordeel	Relevantie	Volgens bron	Gepubliceerd op
HR (Basisregistratie Handelsregister)	KvK hanteert de design rules.	voldoet	van toepassing	Monitor Open Standaarden 2022	18 november 2022
MijnOverheid	MijnOverheid kent drie REST API´s: API t.b.v. de Berichtenbox app;  DvMG (Delen van MijnGegevens) API t.b.v. het ad-hoc, met directe instemming van de burger, delen van inkomensgegevens met woonruimteverdelers; Profielservice API t.b.v. delen van bereikbaarheidsgegevens met GNS t.b.v. KOOP bekendmakingen attenderen.	voldoet	van toepassing	Monitor Open Standaarden 2022	18 november 2022
Ondernemersplein	Voor Ondernemersplein API´s zijn de REST-API Design Rules voor zover mogelijk toegepast.	voldoet	van toepassing	Monitor Open Standaarden 2022	18 november 2022
Samenwerkende catalogi	De leverancier van de SC API (KOOP) geeft in Q1 2023 een indicatieve planning af m.b.t. het voldoen aan de standaard	voldoet niet	van toepassing	Monitor Open Standaarden 2022	18 november 2022
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
Overheid.nl	Op Overheid.nl wordt gebruik gemaakt van de internationale SRU standaard. Deze standaard voor bibliothecaire recordmanagement biedt eenvoudig toegang tot alle informatie op Overheid.nl en sluit aan bij de XML-structuren van de content zelf. Ook kan er integraal gezocht worden door de collecties. Het vervangen van SRU door een REST-API is een kostbare en tijdrovende klus waar momenteel geen middelen voor beschikbaar gesteld zijn. Voor nieuwe collecties zoals PLOOI wordt wel direct gewerkt met REST-API’s.	voldoet niet	van toepassing	Monitor Open Standaarden 2022	18 november 2022
PDOK	PDOK voldoet niet aan deze standaard. Het doel van PDOK is om te voldoen aan de OGC API standaarden	voldoet niet	van toepassing	Monitor Open Standaarden 2022	18 november 2022
TenderNed	Voldoet TenderNed nog niet volledig aan. We zijn in onderzoek hoe wij aan alle regels kunnen voldoen.	voldoet niet	van toepassing	Monitor Open Standaarden 2022	18 november 2022

Toelichting: Bouwstenen en gebruikte standaarden

De omschrijving van het functionele gebruik van de voorziening

Het domein (organisatorisch, taakvelden) binnen de overheid waarin het element (principe, standaard, voorziening..) wordt of kan worden toegepast. Bijvoorbeeld: gemeenten, provincies, waterschappen, Rijk, zorginstellingen, primair onderwijs.