Autorisatie voor het gebruik van de API gebeurt op twee niveau's:
1. autorisatie van de gebruiker door de afnemende organisatie
2. autorisatie van de afnemer (organisatie) door RvIG
Deze feature beschrijft alleen de autorisatie van de afnemer door RvIG.
Voorlopig wordt de reisdocumenten bevragen API alleen aangeboden aan gemeenten voor het raadplegen van reisdocumenten van eigen inwoners.
Autorisatie wordt verkregen met behulp van een OAuth 2 token.
In het verkregen token is de afnemerindicatie opgenomen die de afnemer uniek identificeert. Op basis van de afnemerindicatie kan de autorisatie worden opgezocht.
Wanneer de afnemer een gemeente is, is er ook een gemeentecode opgenomen in de OAuth token. Deze wordt gebruikt om te bepalen of een eigen inwoner houder is van het gevraagde reisdocument.
Voor één afnemer kunnen er meerdere rijen zijn in de autorisatietabel, maar daarvan kan er maar één actueel zijn. Alleen de actuele mag worden gebruikt.
Een autorisatie is actueel wanneer de Datum ingang (35.99.98) in het verleden ligt en Datum beëindiging tabelregel (35.99.99) leeg is of in de toekomst ligt.
Gegeven
de persoon met burgerservicenummer '000000152' heeft een 'reisdocument' met de volgende gegevens
< 1ms
En
de persoon heeft de volgende 'verblijfplaats' gegevens
< 1ms
Gegeven
de afnemer met indicatie '000008' heeft de volgende 'autorisatie' gegevens
< 1ms
En
de geauthenticeerde consumer heeft de volgende 'claim' gegevens
< 1ms
Als
gba reisdocumenten wordt gezocht met de volgende parameters
1s 80ms
Dan
heeft de response 1 reisdocument
< 1ms
Gegeven
de persoon met burgerservicenummer '000000152' heeft een 'reisdocument' met de volgende gegevens
< 1ms
En
de persoon heeft de volgende 'verblijfplaats' gegevens
< 1ms
Gegeven
de afnemer met indicatie '000008' heeft de volgende 'autorisatie' gegevens
< 1ms
En
de geauthenticeerde consumer heeft de volgende 'claim' gegevens
< 1ms
Als
gba reisdocumenten wordt gezocht met de volgende parameters
59ms
Dan
heeft de response een object met de volgende gegevens
< 1ms