Connectoren gebruiken

Stap 1: Connector kiezen

Raadpleeg het connector overzicht om een idee te krijgen van de connectoren die in het platform beschikbaar zijn. De meeste connectoren zijn gebaseerd op REST-communicatie via API.

Stap 2: Connectie aanvragen

Dien een aanvraag in bij de aanbieder van de externe service (bijvoorbeeld MAGDA). Je doorloopt een onboardingsprocedure waarna je een account krijgt met de nodige credentials.

Stap 3: Connector activeren

Activeer de connector in je applicatie aan de hand van volgende stappen.

1. Voeg de juiste dependency toe aan de pom.xml van je applicatie.

2. Voeg de nodige connector instellingen toe aan de applicatie-eigenschappen. Instellingen kan je ofwel rechtstreeks en manueel toevoegen (lokaal of in AWS), ofwel via de Zarn-toepassing. Wie werkt aan een Skryv-gebaseerde eGovFlow-applicatie kan terugvallen op een begeleidende user interface (bereikbaar vanuit de eGovFlow backoffice).

3. Indien mogelijk, kan je de performantie van de connectie configureren via resilience4j.

Stap 4: Connector testen

Hier onderscheiden we twee fases:

1. Testen van de connectie: deze maken doorgaans deel uit van de aanvraag- en onboardingsprocedure (zie hoger). Hiervoor krijg je van de aanbieder de nodige info. Het gaat om geïsoleerde testen met enkel de connectie als voorwerp.

2. End-to-end testen: eenmaal de connectie opgezet is, wil je die verder integreren in je workflows. Om end-to-end testen uit te voeren op een geïsoleerde testomgeving zal je de aan te spreken externe service moeten mocken (mockservice & mockdata). Hiervoor kan je gebruik maken van een tool als CastleMock.

Stap 5: Connector configureren

Integreer de connector binnen je workflow via een service taak of een listener. Hier gebeurt de mapping van inputparameters en van alle opgehaalde data. Voor frequent gebruikte connectoren is er een service taak template beschikbaar.