API-documentatie
We maken 2 types API-documentatie beschikbaar:
Voor de POST-call, die alleen kan gedaan worden door de afzender, vindt u hieronder een codevoorbeeld.
POST-call
Deze call plaatst een nieuw ophaalverzoek voor de notificatiebundel: POST/api/v2/notificaties
Een voorbeeld van een payload bij een notificatiebundel voor passieve notificaties:
{
"VerzendDatum": null,
"Id": "92a6044e-362b-4562-a96b-f358d6b5da0f",
"Bestemmelingen": [
{
"Identificatie": "00010100173",
"Type": "RijksRegisterNummer"
},
{
"ContactInfo": {
"Email": "test@test.com"
},
"Type": "PersoonMetContactInfo"
},
{
"ContactInfo": {
"Email": "test@test.com"
},
"Type": "OrganisatieMetContactInfo"
},
{
"OndernemingsNummer": "0123321123",
"Type": "GeregistreerdeOrganisatie"
}
],
"Categorie": {
"Code": "TerugmeldingMelder"
},
"TransactieId": "interne-referentie-ea97ae17-3cc2-47cc-ab92-52da1c6a7afc",
"VervalDatum": "2023-09-07T11:43:41.573Z",
"Kanalen": [
{
"Type": "Passief"
}
],
"ProductId": "201",
"SleutelWaardeParen": [
{
"Waarde": "VoorbeeldWaarde",
"Sleutel": "VoorbeeldSleutel"
},
{
"Waarde": [
{
"Waarde": [
{
"Waarde": "VoorbeeldChildWaarde",
"Sleutel": "VoorbeeldChildListSleutel1"
},
{
"Waarde": "VoorbeeldChildListWaarde",
"Sleutel": "VoorbeeldChildListSleutel2"
}
],
"Sleutel": "0"
},
{
"Waarde": [
{
"Waarde": "VoorbeeldChildListWaarde",
"Sleutel": "VoorbeeldChildListSleutel1"
},
{
"Waarde": "VoorbeeldChildListWaarde",
"Sleutel": "VoorbeeldChildListSleutel2"
}
],
"Sleutel": "1"
}
],
"Sleutel": "VoorbeeldLijstObjecten"
},
{
"Waarde": [
{
"Waarde": "VoorbeeldChildWaarde",
"Sleutel": "VoorbeeldChildSleutel1"
},
{
"Waarde": "VoorbeeldChildWaarde",
"Sleutel": "VoorbeeldChildSleutel2"
}
],
"Sleutel": "VoorbeeldObject"
}
]
}
Een voorbeeld van een payload bij een notificatiebundel voor een vrije notificaties:
{
"Id": "85144567-7043-4469-9e79-279f4eb31e27",
"Bestemmelingen": [
{
"Identificatie": "80102529724",
"Type": "RijksRegisterNummer"
},
],
"Categorie": {
"Code": "VrijeNotificatie",
},
"TransactieId": "interne-referentie-111",
"VerzendDatum": "2021-07-27T14:25:05.514Z",
"VervalDatum": "2022-03-01T10:00:10.514Z",
"Kanalen": [
{
"Type": "Passief",
},
],
"ProductId": "130",
"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"
},
]
}
Template voor de NotificatieCategorie “Vrije Notificaties”
De inkomende en uitgaande sleutelwaardeparen zijn identiek. Bovendien zijn de sleutelwaardeparen identiek voor beide kanalen: passief en e-mail.
Verplichte Sleutels | Waarde | Omschrijving |
|---|---|---|
Titel | string | De titel van de notificatie |
Body | string | Vrij te kiezen tekst met beperkte opmaakmogelijkheden. De toegelaten html-tags zijn:
|
Optionele Sleutels | Waarde | Omschrijving |
DocumentLinkUri | string | Een deep-link naar meer informatie voor de bestemmeling, vb. naar de detailpagina in het loket van het agentschap van de broninformatie. |
ExterneLinkNaam | string - maximum 25 karakters | Het label dat moet gebruikt worden voor de deep-link |
Template voor de NotificatieCategorie “Vervaldagbericht”
De inkomende en uitgaande sleutelwaardeparen zijn identiek. Bovendien zijn de sleutelwaardeparen identiek voor beide kanalen: passief en e-mail.
Verplichte Sleutels | Waarde | Omschrijving |
|---|---|---|
ArtikelNaam | string | De naam van het product dat vervalt, bijvoorbeeld: “Elektronische identiteitskaart” |
Vervaldatum | string (datum/tijd) | De effectieve datum waarop het artikel vervalt |
Optionele Sleutels | Waarde | Omschrijving |
BegeleidendeInfo | string | Vrij te kiezen aanvullende tekst met beperkte opmaakmogelijkheden. Dit is niet de body van de notificatie. Toegelaten HTML-tags zijn
|
DocumentLinkUri | string | Een deeplink naar meer informatie voor de bestemmeling, bijv. naar de detailpagina van het product in het loket van het agentschap dat de broninformatie beheert |
ExterneLinkNaam | string | Het label dat moet gebruikt worden voor de deep-link |
Een voorbeeld van een payload met informatie over een vervaldagbericht:
{
"Id": "e682c962-fe95-47d8-9cd2-65edc059d706",
"TransactieId": "interne-referentie-e42231b6-b98c-48fd-bcfc-2a535d10346b",
"ProductId": "148",
"VerzendDatum": "2021-05-03T07:24:00Z",
"VervalDatum": "2021-05-05T00:00:00Z",
"Bestemmelingen": [
{
"Identificatie": "99999999999",
"Type": "RijksRegisterNummer"
}
],
"Categorie": {
"Code": "VervaldagBericht"
},
"Kanalen": [
{
"Type": "Email"
},
{
"Type": "Passief"
}
],
"SleutelWaardeParen": [
{
"Waarde": "Elektronische identiteitskaart",
"Sleutel": "ArtikelNaam"
},
{
"Waarde": "2021-06-03",
"Sleutel": "Vervaldatum"
},
{
"Waarde": "<p>Breng mee: <ul><li>oude identiteitskaart</li><li>uitnodiging om een nieuwe identiteitskaart op te halen</li></ul></p>",
"Sleutel": "BegeleidendeInfo"
},
{
"Waarde": "https://www.vlaanderen.be/elektronische-identiteitskaart-eid",
"Sleutel": "DocumentLinkUri"
},
{
"Waarde": "Elektronische identiteitskaart (eID)",
"Sleutel": "ExterneLinkNaam"
}
]
}
Uitgestelde notificaties
Dit zijn notificatiebundels die worden aangemaakt om op een later tijdstip te versturen naar de bestemmeling.
In het NotificatieBundelVerzoek wordt hiervoor een veld VerzendDatum toegevoegd. Zodra daar een datum wordt ingevuld, dan gelden de volgende voorwaarden:
De tijdzone moet ook ingevuld zijn (timezone = ISO 8601). Dit is noodzakelijk om te vermijden dat het tijdstip hetzelfde is, maar in een andere tijdzone.
De datum moet in de toekomst liggen
Er is geen minimum toekomstige datum. Gebruik dit veld zinvol: maak bijvoorbeeld geen notificatie die een half uur later kan worden uitgestuurd.
Er is echter wel een maximale datum in de toekomst, nl. vandaag + 1 maand. Hiermee vermijdt u dat de informatie in de notificatie niet meer accuraat/gevalideerd is.
De volgende velden hoeft u niet in te vullen:
Afzenderorganisatiecode: Digitaal Vlaanderen vult hier de OVO-code in van de organisatie die de notificaties verstuurt. De OVO-code is gekend uit de ACM Client claims.
Merkcode: staat al vooraf geconfigureerd door Digitaal Vlaanderen
Schrijf OVO-code altijd met hoofdletters.