Page Comparison

API-documentatie

Zie de Swagger-documentatie bij de Notificaties API. Voor de belangrijkste call, de POST-callWe maken 2 types API-documentatie beschikbaar:

• voor agenten/loketten

• voor afzenders

Voor de POST-call, die alleen kan gedaan worden door de afzender, vindt u hieronder een voorbeeldcodevoorbeeld.

POST-call

Voor het doorsturen van notificaties is er 1 API-call nodig: POST Deze call plaatst een nieuw ophaalverzoek voor de notificatiebundel: POST/api/v2/notificaties

Een voorbeeld van een payload om een passieve notificatie uit te sturenbij 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" 
    }, 
  ] 
} 

...

De inkomende en uitgaande sleutelwaardeparen zijn identiek. Bovendien zijn de sleutelwaardeparen identiek voor beide kanalen: passief en e-mail.

Template voor de NotificatieCategorie “Vervaldagbericht”

De inkomende en uitgaande sleutelwaardeparen zijn identiek. Bovendien zijn de sleutelwaardeparen identiek voor beide kanalen: passief en e-mail.

Een voorbeeld van een payload met informatie over een vervaldagbericht:

{
  "Id": "e682c962-fe95-47d8-9cd2-65edc059d706",
  "TransactieId": "interne-referentie-e42231b6-b98c-48fd-bcfc-2a535d10346b",
  "AfzenderOrganisatieCode": "OVO000001",
  "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"
    }
  ]
}

...

• 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.