De client (ID XXXX) wordt geconfigureerd voor de gevraagde IPDC-producten.
Zo kan voor IPDC-product 228 (https://productencatalogus.vlaanderen.be/fiche/228) notificaties worden verstuurd.
API-documentatie
Documentatie over de API (+de swagger interface) kan je vinden op https://beta.notificatie.dev-vlaanderen.be/Ik geef graag mee dat voor
API-calls
Voor het doorsturen van notificaties je eigenlijk maar is er 1 API-call nodig hebt: POST /api/v2/notificaties
Dat is dus de belangrijkste call waarmee je aan de slag kan gaan. Als bijlage kan je ook een voorbeeld payload vinden Een voorbeeld van een payload om een passieve notificatie uit te kunnen sturen.:
Deze API is beveiligd via OAuth 2.0. Er werd hiervoor een nieuwe oauth client opgezet voor VLABEL.
Er wordt gewerkt met de OAuth 2.0 Client Credentials Flow: deze staat hier beschreven: https://beta.oauth.vlaanderen.be/authorization/Help/Api/ClientCredentialsGrant
Voor DOSIS en notificaties verplichten we het gebruik van client authenticatie op basis van een assymetrische sleutel via een JSON Web Token.
Meer info: https://beta.oauth.vlaanderen.be/authorization/Help/Api/ClientAuthentication#private_key_jwt Een stukje .NET code kan je vinden op https://vlaamseoverheid.atlassian.net/wiki/spaces/GEO/pages/1915388760/JSON+Web+Token
Als sleutel kan dus een keypair of een X509 certificaat gebruikt worden. Op bovenstaande helppagina staat een dotnet tooltje om dergelijk keypair en json web token te genereren, maar dit kan ook met tools zoals openssl etc.
Voor je hiermee aan de slag kan gaan moet het publieke gedeelte aan je OAuth client gehangen worden. Dit kan door in te loggen op https://beta.oauth.vlaanderen.be/admin waar je een overzicht krijgt van je OAuth clients.
Peter Delamarre (dxc) is client owner en kan dit uitvoeren => geef gerust door als er nog andere personen client owner moeten worden, maar Peter was dit ook voor de andere VLABEL clients (voor de documentendienst bvb.)
Client ID: 5775
De notificatiebouwsteen werd geconfigureerd zodat je voor IPDC product 228 (https://productencatalogus.vlaanderen.be/fiche/228) notificaties kan versturen.
Testen kan je doen door een notificatiebundel te versturen naar bepaalde rijksregisternummers (bvb je eigen rrn) en dan in te loggen op de Mijn Burgerprofiel beta omgeving:
https://beta.frontend.burgerprofiel.dev-vlaanderen.be/
Deze omgeving zit niet achter ACM-IDM maar achter een mock-loginscherm. Je kan inloggen als een bepaalde burger door zelf een rijksregisternummer in te vullen:
...
| Code Block |
|---|
{
"Id": "85144567-7043-4469-9e79-279f4eb31e27",
"Bestemmelingen": [
{
"Identificatie": "80102529724",
"Type": "RijksRegisterNummer"
},
],
"Categorie": {
"Code": "VrijeNotificatie",
},
"TransactieId": "interne-referentie-111",
"VervalDatum": "2019-11-27T14:25:05.514Z",
"Kanalen": [
{
"Type": "Passief",
},
],
"ProductId": "130",
"MerkCode": "FONS",
"SleutelWaardeParen": [
{
"Sleutel": "Body",
"Waarde": " Uw inschrijving tot de dienstenchequesportaal is bevestigd"
},
{
"Sleutel": "Titel",
"Waarde": "Inschrijving dienstencheques"
},
{
"Sleutel": "DocumentLinkUri",
"Waarde": "http://www.dienstencheques.vlaanderen.be/xxx"
},
{
"Sleutel": "ExterneLinkNaam",
"Waarde": "Meer informatie"
},
]
} |