API-standaarden

Wat zijn API's?

Een application programming interface (API) is een gestructureerd en gedocumenteerd koppelvlak voor communicatie tussen applicaties. 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.

Welke API standaarden heeft Logius in Beheer

Logius beheert momenteel 2 API standaarden:

  • De REST-API Design Rules (ADR)
  • Het Nederlandse overheid toepassingsprofiel op OAuth 2.0 (NL Gov OAuth profiel)

ADR

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.

Het NL Gov OAuth profiel

OAuth is een beveiligingstandaard voor het autoriseren van toegang tot REST API’s. Het NL GOV profiel op OAuth 2.0 legt bindende afspraken vast over het gebruik van de de standaard OAuth 2.0 bij de Nederlandse overheid. In combinatie met onderliggende standaard OAuth 2.0 zorgt NL GOV profiel ervoor dat de autorisatie van gebruikers van REST APIs van de overheid op een uniforme en eenduidige wijze plaatsvindt.

Voor wie zijn deze standaarden?

Beide standaarden hebben een ‘pas toe of leg uit’ - verplichting voor Nederlandse overheden en instellingen uit de (semi) publieke sector en staan op de lijst met verplicht toe te passen open standaarden van Forum Standaardisatie.

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.

Het NL GOV OAuth profiel moet worden toegepast bij applicaties waarbij gebruikers of ‘resource owners’ impliciet of expliciet toestemming geven aan een dienst van een derde om namens deze toegang te krijgen tot gegevens via een REST API waarvoor ze recht van toegang hebben.