Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Documentatie over de API (+de swagger interface) kan je vinden op https://beta.notificatie.dev-vlaanderen.be/

API-calls

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

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

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" 
    }, 
  ] 
}