Interface beschrijvingen
NDW Datakwaliteit levert enkele API endpoints voor het distribueren van kwaliteitsdata.
| Naam | Beschrijving | Swagger UI Documentatie |
|---|---|---|
| Quality Framework | Het Quality Framework is een raamwerk waarin voor verschillende databronnen bij NDW kwaliteitsindicatoren zijn gedefinieerd. Deze endpoints leveren zowel de indicatoren als de maandelijkse kwaliteitscijfers uit het Quality Framework. | Open documentatie |
| Validated Locations | De Validated Locations endpoints leveren voor een aantal databronnen een overzicht van gevalideerde locaties. Deze locaties zijn aan de hand van onze logica gecontroleerd en opgesteld. | Open documentatie |
Authenticatie
Authenticatie verloopt via OAuth. Bij aanroep van de API moet een “OAuth token” worden meegestuurd. Via de NDW Identity & Access Management server kan een dergelijk OAuth token verkregen worden. Hoewel het mogelijk om met een persoonlijk NDW account toegang te krijgen tot de API is het voor programmatische/systeem toegang aan te raden een zogenaamd service account te gebruiken. Een NDW service account voor de Datakwaliteit API kunt u aanvragen bij de NDW servicedesk. Vermeld bij contact duidelijk dat het gaat om een “service account voor afname van datakwaliteits data”.
Voorbeeld
Als u over een service account beschikt dan kan op de volgende wijze een OAuth token worden verkregen (via curl):
curl \
-d "client_id=<uw client_id>" \
-d "client_secret=<uw client secret>" \
-d "grant_type=client_credentials" \
https://iam.ndw.nu/auth/realms/ndw/protocol/openid-connect/token
Hierop volgt onderstaand response:
{
"access_token": "",
"expires_in": 1800,
"refresh_expires_in": 3600,
"refresh_token": "",
"token_type": "Bearer",
"not-before-policy": 0,
"session_state": "81ae1763-9c99-4c54-99b8-5e0629f8a2d6",
"scope": "profile email"
}
Het response bevat een access_token. De inhoud van dit access_token moet bij aanroep van de API worden meegestuurd. Dit kan middels de volgende HTTP header:
Authorization: Bearer