API integratie
Deze pagina beschrijft hoe de integratie met de API plaats moet vinden.
Om te kunnen interacteren met de API is een
API-Key nodig. Deze key kan aangevraagd worden bij VZVZ. De key wordt gebruikt om zeker te weten dat de aanvragende partij toegang heeft tot de service en biedt mogelijkheid tot meten van het validatieservice gebruik.Wanneer de
API-Key is ontvangen, dient deze in een X-API-KEY header (case insensitive) meegegeven te worden op elke request naar de validatieservice.Dit is een voorbeeld van een request:
fetch("https://koppeltaal.validator.headease.nl/v1/careplan?allEntitiesVersioned=false", {
"headers": {
"X-Api-Key": "3e9650a0-53e9-45e7-b71f-8c034e26b07b",
"Content-Type": "application/xml",
},
"body": "<SOME_XML_CONTENT>",
"method": "POST",
});
De API services worden meegeleverd met API documentatie. Wanneer je naar de root van de validatieservice gaat in de browser worden automatisch alle endpoints met specs beschreven. Ook kan deze vanuit de API documentatie direct getest worden op de validatieservice.
Koppeltaal werkt met
CreateOrUpdateberichten. De validatieservice weet niet of een bericht eenCreateof een Updatezou moeten zijn aangezien wij niet aangesloten zijn in het domein of toegang hebben tot de Koppeltaal database. Daarom dient de validatie van een Create uitgevoerd te worden tegen een POST request en een Update tegen een PUT request.Last modified 2yr ago