DIGITAAL VLAANDEREN
Verifier API v1
De MAGDA Solid diensten zijn specifieke REST diensten ontworpen voor het Solid ecosysteem van Datanutsbedrijf, daarom wijken ze soms af van de gangbare conventies voor MAGDA Webservices & MAGDA REST diensten waar dit genoodzaakt is om compatibiliteit met het Solid ecosysteem te waarborgen.
Situering
Deze dienstverlening kadert binnen het Solid-domein van MAGDA Platform, en meerbepaald binnen het MAGDA Solid Attestation Service aanbod die het voor afnemers en bronnen eenvoudig maakt om authentieke data te ontsluiten via de Solid datakluis in de vorm van een Verifiable Credential.
De Verifier Service maakt het mogelijk voor een derde partij om een Verifiable Credential te valideren tegen de vereisten van het Solid ecosysteem op vlak van uitgever, handtekening, geldigheidsperiode en eventuele intrekking. Hierbij hoeft de Verifier slechts één API call uit te voeren naar de Verifier Service om al deze criteria te valideren, en moet er zelf geen complexe logica worden voorzien om digitale handtekeningen te valideren of de intrekkingsstatus te controleren.
Verwante diensten
De Verifier Service zal enkel succesvol attestaties valideren onder de vorm van een Verifiable Credential uitgegeven door de MAGDA Solid Attestation Service.
Gebruiksvoorwaarden
Om gebruikt te kunnen maken van deze dienst dient men een aansluitingsprocedure te doorlopen op de MAGDA Solid dienstverlening, in kader van een integratie met het Solid-ecosysteem van Vlaams Datanutsbedrijf.
Functionaliteiten
Deze API maakt het mogelijk om Verifiable Credentials uitgegeven door de Attestation Service te valideren op vlak van digitale handtekening, intrekkingsstatus en geldigheidsperiode tegen de VC Data Integrity en Revocation List 2020 standaarden van de W3C.
Vraag
POST /credentials/verify
In de request naar dit endpoint geeft de afnemer een Verifiable Credential mee, dewelke verkregen werd uit de Solid datakluis van een data subject.
Antwoord
POST /credentials/verify
De respons vat het resultaat samen van de Verificatie, het geeft aan welke checks succesvol werden uitgevoerd, identified by a key based on the Verifiable Credentials 1.0 Data Model, and will identify any of the errors that have occurred in case a 400 Bad Request is returned.
Werking
Aandachtspunten
Deze API maakt gebruik van Solid-OIDC Authenticatie, dit authenticatiemiddel kan door de afnemer op twee manieren worden opgezet:
Via een aansluiting op ACM/IDM (voor entiteiten binnen de Vlaamse overheid), door middel van OAuth Client-Credentials Grant.
Via een eigen OpenID Provider die Solid-OIDC ondersteunt (voor private partijen aangesloten bij het ecosysteem van Vlaams Datanutsbedrijf).
Daarnaast is het verplicht om DPoP te gebruiken bij het aanspreken van de Verifier Service, om te beschermen tegen een eventueel hergebruik van de ID Tokens die nodig zijn om te authenticeren met deze API binnen het Solid ecosysteem.
Responsetijden & Beschikbaarheid
Deze dienst heeft volgende gemiddelde performantie in performantietesten behaald:
Gemiddelde respons tijd | 1 sec |
90 percentiel | 2 sec |
95 percentiel | 3 sec |
Max error rate | < 1% |
Merk op dat rate limiting toegepast wordt op deze dienstverlening, met een maximum van 10 requests/seconde.
Logging
De opvragingen die gebeuren via deze webservice dienen te worden bewaard zoals beschreven op de pagina "MAGDA logging". Dit houdt in dat een afnemer die de Verifier Service aanroept minstens volgende gegevens moet bijhouden in haar audit log:
Gegeven | Omschrijving |
|---|---|
Referentie | Unieke identificatie van de request, die met MAGDA platform werd gedeeld via ten minste één van volgende HTTP request-headers:
|
Wat | Identificatie van de MAGDA API die werd aangesproken (e.g. het gebruikte endpoint) |
Wie | Identificatie van de toepassing van de afnemer |
Gebruiker | INSZ nummer of andere unieke identifier van de gebruiker van de toepassing van de afnemer |
Waarom | Finaliteit waarvoor deze vraag werd gesteld |
Wanneer | tijdstip waarop de vraag / het antwoord verwerkt wordt |
Over wie | Identificatie van het data subject waarop deze bevraging toepassing heeft. |
Op deze pagina
Binnen deze handleiding
Omgevingsinformatie
Domein | Solid |
|---|
Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren
De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid
uitgegeven door Digitaal Vlaanderen