{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"7"}},"macroMetadata":{"macroId":{"value":"f19e6387-4053-4645-808e-522db4ecefdd"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"c44ee336-b27c-41d5-ab23-38556ad35764"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"API-documentatie","type":"text"}]},{"type":"paragraph","content":[{"text":"We maken 2 types API-documentatie beschikbaar:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"voor agenten/loketten","type":"text","marks":[{"type":"link","attrs":{"href":"https://notificaties.api.vlaanderen.be/api/public/swagger/index.html?urls.primaryName=Notificaties.Api%20voor%20Agenten%2FLoketten"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"voor afzenders","type":"text","marks":[{"type":"link","attrs":{"href":"https://notificaties.api.vlaanderen.be/api/public/swagger/index.html?urls.primaryName=Notificaties.Api%20voor%20Afzenders"}}]}]}]}]},{"type":"paragraph","content":[{"text":"Voor de POST-call, die alleen kan gedaan worden door de afzender, vindt u hieronder een codevoorbeeld. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"POST-call","type":"text"}]},{"type":"paragraph","content":[{"text":"Deze call plaatst een nieuw ophaalverzoek voor de notificatiebundel:","type":"text"},{"text":" POST/api/v2/notificaties","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Een voorbeeld van een payload bij een notificatiebundel voor een vrije notificaties:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{ \n  \"Id\": \"85144567-7043-4469-9e79-279f4eb31e27\", \n  \"Bestemmelingen\": [ \n    { \n      \"Identificatie\": \"80102529724\", \n      \"Type\": \"RijksRegisterNummer\" \n    }, \n  ], \n  \"Categorie\": { \n    \"Code\": \"VrijeNotificatie\", \n  }, \n \"TransactieId\": \"interne-referentie-111\", \n \"VerzendDatum\": \"2021-07-27T14:25:05.514Z\", \n \"VervalDatum\": \"2022-03-01T10:00:10.514Z\",\n  \"Kanalen\": [ \n    { \n      \"Type\": \"Passief\", \n    }, \n  ], \n  \"ProductId\": \"130\", \n  \"SleutelWaardeParen\": [ \n    { \n      \"Sleutel\": \"Body\", \n      \"Waarde\": \" Uw inschrijving tot de dienstenchequesportaal is bevestigd\" \n    }, \n { \n      \"Sleutel\": \"Titel\", \n      \"Waarde\": \"Inschrijving dienstencheques\" \n    }, \n { \n      \"Sleutel\": \"DocumentLinkUri\", \n      \"Waarde\": \"http://www.dienstencheques.vlaanderen.be/xxx\" \n    }, \n { \n      \"Sleutel\": \"ExterneLinkNaam\", \n      \"Waarde\": \"Meer informatie\" \n    }, \n  ] \n} ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Wens je notificaties in een andere taal dan het Nederlands te sturen, volg dan de instructies op ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/5565088407/Overzicht+basisbegrippen+Notificaties#Meertaligheid"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Template voor de NotificatieCategorie “Vrije Notificaties”","type":"text"}]},{"type":"paragraph","content":[{"text":"De inkomende en uitgaande sleutelwaardeparen zijn identiek. Bovendien zijn de sleutelwaardeparen identiek voor beide kanalen: passief en e-mail.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"25218df4-0db9-4f25-ba64-cd8b3c8d3d7b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Verplichte Sleutels","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Waarde","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Omschrijving","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Titel","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"De titel van de notificatie","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Body","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Vrij te kiezen tekst met beperkte opmaakmogelijkheden. De toegelaten html-tags zijn: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"

","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"

","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Optionele Sleutels","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Waarde","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Omschrijving","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"DocumentLinkUri","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Een deep-link naar meer informatie voor de bestemmeling, vb. naar de detailpagina in het loket van het agentschap van de broninformatie.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"ExterneLinkNaam","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"string - maximum 25 karakters","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Het label dat moet gebruikt worden voor de deep-link","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Template voor de NotificatieCategorie “Vervaldagbericht” ","type":"text"}]},{"type":"paragraph","content":[{"text":"De inkomende en uitgaande sleutelwaardeparen zijn identiek. Bovendien zijn de sleutelwaardeparen identiek voor beide kanalen: passief en e-mail.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1bd8bede-5bdd-4bc1-bdae-37dd40c5c8f6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Verplichte Sleutels","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Waarde","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Omschrijving","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"ArtikelNaam","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"De naam van het product dat vervalt, bijvoorbeeld: “Elektronische identiteitskaart”","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Vervaldatum","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"string (datum/tijd)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"De effectieve datum waarop het artikel vervalt","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Optionele Sleutels","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Waarde","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Omschrijving","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"BegeleidendeInfo","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Vrij te kiezen aanvullende tekst met beperkte opmaakmogelijkheden. Dit is niet de body van de notificatie. Toegelaten HTML-tags zijn ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"
","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"

Browser not supported