API-documentatie

Zie de Swagger-documentatie bij de Notificaties API. Voor de belangrijkste call, de POST-call, vindt u hieronder een voorbeeld.

POST-call

Voor het doorsturen van notificaties is er 1 API-call nodig: POST /v2/notificaties

Een voorbeeld van een payload om een passieve notificatie uit te sturen:

{ 
  "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: <p> <ul> <ol> <li>
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

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.

Vervaldagbericht