Main content

REST-API Design Rules

De REST-API Design Rules (ADR) hebben tot doel om meer uniformiteit te brengen in de manier waarop de overheid REST-API's aanbiedt. Met dit doel beschrijft de standaard een aantal basisregels voor het structureren en documenteren van REST-API's. De ADR moeten toegepast worden daar waar de overheid REST-API's inzet. Het gebruik van REST-API's bij het ontsluiten van gegevens of functionaliteit is op zichzelf niet verplicht.

NL Gov OAuth-profiel

OAuth 2.0 is een open standaard voor de beveiliging van applicaties die gegevens uitwisselen met behulp van REST-API’s. Met OAuth 2.0 kunnen gebruikers een website of webapplicatie autoriseren om hun persoonlijke gegevens via een REST-API op te halen bij een ander systeem, zonder daarbij hun gebruikersnaam en wachtwoord uit handen te geven. OAuth 2.0 maakt hiervoor gebruik van een techniek (via tokens) die toegang geeft tot specifieke gegevens van een gebruikersaccount voor een bepaalde duur.

OAuth 2.0 is een generieke standaard die meestal nog aanvullende afspraken vereist voor de toepassing in specifieke domeinen. Het NL Gov OAuth-profiel legt dit soort nadere afspraken vast voor het gebruik van OAuth 2.0 bij de Nederlandse overheid. Zo bepaalt het profiel hoe applicaties zich bij elkaar moeten registreren en hoe autorisatiecodes veilig uitgewisseld moeten worden. OAuth 2.0 laat daarin bijvoorbeeld veel implementatieopties vrij. Dit komt de interoperabiliteit niet ten goede, daarom beperkt het NL Gov OAuth-profiel het aantal opties.