|
|
|
|
|
DCB - Koppeling met VKG extranet
Met het extranet van de Van Kampen Groep kan gekoppeld worden via een aantal aanroepen:
Zoeken van een relatie.
Er kan een zoekopdracht op een relatie in het extranet van VKG gedaan worden via een aanroep naar:
relaties/api/v1/vkgrelaties? DiasVkgRelatieId=<externrelatienummer>& Geboortedatum=<geboortedatum>& TypeRelatie=<Persoon|Instantie>& Postcode=<postcode>& Huisnummer=<huisnummer>
- DiasVkgRelatieId, dit is het relatienummer waaronder onze relatie in het VKG extranet bekend is.
- Geboortedatum, de geboortedatum van de relatie indien het een persoon is
- TypeRelatie, is het een persoon of een instantie
- Postcode, de postcode van het postadres van de relatie
- Huisnummer, het huisnummer van het postadres van de relatie.
{
"Data": [
{
"RelatieId": 0,
"VkgRelatienummer": "string",
"VkgDiasRelatieId": "string",
"Naam": "string",
"AandTypeRelatie": "NotSet",
"StandaardEmailadres": "string",
"VkgAdviseurId": 0,
"Achternaam": "string",
"Voorletters": "string",
"Voorvoegsels": "string",
"DatumGeboorte": "2022-07-22T13:46:38.817Z",
"GeslachtId": "NotSet",
"KvkNummer": "string",
"RechtsvormId": 0,
"Bedrijfsnaam": "string",
"Adressen": [
{
"TypeAdres": "NotSet",
"Huisnummer": 0,
"HuisnummerToevoeging": "string",
"Plaats": "string",
"Straat": "string",
"PostcodeNederland": "string",
"PostcodeBuitenland": "string"
}
]
}
],
"Paging": {
"PageNo": 0,
"PageSize": 0,
"PageCount": 0,
"TotalRecordCount": 0
}
}
Aanmelden van een relatie
Als de relatie niet bekend is bij VKG, dan kan deze aangemeld worden via een PUT op:
relaties/api/v1/vkgrelaties/aanmelden
In de body moet het id van de relatie meegegeven worden die aangemeld moet wordt bij het extranet van VKG. De body ziet er als volgt uit:
{
“RelatieId” : 0
}
Bij het aanmelden wordt voor de relatie een uniek extern relatienummer aangemaakt. Dit nummer wordt samen met het relatienummer van VKG opgeslagen.
Het resultaat van de aanroep:
{
"VkgRelatieId": "string",
"VkgRelatieUrl": "string"
}
Hierbij is het VkgRelatieId het nummer waaronder de relatie in VKG bekend staat. Dit is niet het extern relatienummer, maar een intern nummer in het VKG systeem. De VkgRelatieUrl kan gebruikt worden om naar de relatiegegevens in het VKG systeem te navigeren.
Controleren van een relatie
De gegevens van de relatie kunnen verschillen tussen de eigen administratie van de tussenpersoon en het VKG extranet. Uitgangspunt is dat de eigen administratie leidend is. Om te controleren of de gegevens gelijk zijn is er een controle mogelijk. Dit is een PUT op:
relaties/api/v1/vkgrelaties/controleren
In de body moet het id van de te controleren relatie opgegeven worden:
{
“RelatieId” : 0
}
De gegevens van de opgegeven relatie wordt vergeleken met de gegevens in het VKG systeem. Het resultaat is:
{
"VkgGegevensZijnAndersDanDias": true,
"RelatieId": 0,
"DiasRelatieGegevens": {
"VkgRelatienummer": "string",
"VkgDiasRelatieId": "string",
"AandTypeRelatie": "NotSet",
"Naam": "string",
"Voorletters": "string",
"Voorvoegsels": "string",
"DatumGeboorte": "2022-07-22T14:00:36.574Z",
"GeslachtId": "NotSet",
"KvkNummer": "string",
"RechtsvormId": 0,
"StandaardEmailadres": "string",
"Telefoonnummer": "string",
"MobielTelefoonnummer": "string",
"Adressen": [
{
"TypeAdres": "NotSet",
"Huisnummer": 0,
"HuisnummerToevoeging": "string",
"Plaats": "string",
"Straat": "string",
"PostcodeNederland": "string",
"PostcodeBuitenland": "string"
}
],
"Ibans": [
"string"
]
},
"VkgRelatieGegevens": {
"VkgRelatienummer": "string",
"VkgDiasRelatieId": "string",
"AandTypeRelatie": "NotSet",
"Naam": "string",
"Voorletters": "string",
"Voorvoegsels": "string",
"DatumGeboorte": "2022-07-22T14:00:36.574Z",
"GeslachtId": "NotSet",
"KvkNummer": "string",
"RechtsvormId": 0,
"StandaardEmailadres": "string",
"Telefoonnummer": "string",
"MobielTelefoonnummer": "string",
"Adressen": [
{
"TypeAdres": "NotSet",
"Huisnummer": 0,
"HuisnummerToevoeging": "string",
"Plaats": "string",
"Straat": "string",
"PostcodeNederland": "string",
"PostcodeBuitenland": "string"
}
],
"Ibans": [
"string"
]
},
"ResultMessages": {
"HasWarnings": true,
"HasInfo": true,
"Warnings": [
{
"Code": "string",
"Message": "string"
}
],
"Info": [
{
"Code": "string",
"Message": "string"
}
]
}
}
- VkgGegevensZijnAndersDanDias, zijn er verschillen tussen de gegevens in het eigen systeem en het VKG systeem.
- RelatieId, het opgegeven relatie id.
- DiasRelatieGegevens, de gegevens uit het eigen systeem.
- VkgRelatieGegevens, de gegevens uit het VKG systeem.
Relatie bijwerken
Als de gegevens tussen het eigen systeem en het VKG systeem van elkaar afwijken, dan kunnen de VKG gegevens gelijkgetrokken worden met de gegevens uit het eigen systeem. Dit gaat via een PUT op:
relaties/api/v1/vkgrelaties/wijzigen
In de body van de aanroep moet het relatie id opgegeven worden van de relatie die gewijzigd moet worden:
{
“RelatieId”: 0
}
De opgegeven relatie wordt bijgewerkt. Het resultaat
{
"VkgRelatieId": "string",
"VkgRelatieUrl": "string"
}
- vkgRelatieId, het id van de relatie in het VKG systeem
- vkgRelatieUrl, de url naar de relatiegegevens in het VKG systeem.
Polismap van de relatie
Binnen VKG kan het overzicht van de polissen van de relatie opgevraagd worden. Dit is een url die ofwel particuliere polissen ofwel zakelijke polissen bevat. Voor particuliere relaties kunnen beide aanwezig zijn, voor zakelijke alleen de zakelijke polissen.
Het opvragen van de particuliere polissen is een GET op:
Contracten/api/v1/vkgpolissen/particulier?relatieid=<id>
Op de url moet het id van de relatie opgegeven worden waarvoor het polisoverzicht opgevraagd moet worden. Het resultaat van de aanroep:
{
"VkgRelatieId": "string",
"Url": "string"
}
Het resultaat is gelijk aan het resultaat van de particuliere polissen.
Individuele polis
Binnen het VKG systeem kan genavigeerd worden naar een specifieke polis. Dit is een GET naar:
contracten/api/v1/vkgpolissen/{id}
Het id is het contract id van de polis in de eigen administratie.
Het resultaat van de aanroep:
{
"VkgPolisId": "string",
"Polisnummer": "string",
"Url": "string",
"ExtranetPlusMultiplePoliciesUrl": [
"string"
]
}
- VkgPolisId, het id van de polis in het VKG systeem.
- Polisnummer, is nu altijd leeg.
- URL, de url om in het VKG systeem naar de polis te kunnen navigeren
- ExtranetPlusMultiplePoliciesUrl, uitzonderingssituatie waarbij meerdere polissen gevonden worden. Voorlopig wordt dit niet ondersteund en zal dit nooit gevuld worden.
Inrichten van de VKG koppeling
Voor het inrichten van de koppeling met VKG moeten 4 instellingen gevuld worden:
- VKG-Koppeling Url: de url naar de webapi van VKG
- VKG-Koppeling App key: de API key voor het VKG systeem.
- VKG-Koppeling Inlognaam: de inlognaam in het VKG systeem.
- VKG-Koppeling Wachtwoord: het wachtwoord voor het VKG systeem.