Digipost webservices
Integratieproces
Elke vraag voor een API-integratie tussen een toepassing en DigiPost, wordt gericht aan Facilipunt.
Hierbij moeten minstens volgende vragen worden beantwoord:
- Wat is de doelstelling van de integratie?
- Welke timing wordt er vooropgesteld?
De aanvraag wordt samen besproken. Zo krijgen we een duidelijk beeld van de omvang, eventuele voorbereidende stappen, beslissingen of verdere punten om te verduidelijken. DigiPost zal dan een aanspreekpunt aanduiden voor het verdere verloop van het traject.
- Stap 1
Projectplanning
Het aanspreekpunt van DigiPost maakt samen met de klant een planning. Voor DigiPost zijn standaard API’s beschikbaar. De klant voert dus een belangrijk deel van het werk zelf uit.
Nadat deze fase is afgerond, is er een duidelijk projectplan met daarin ingeschatte timing en afspraken. Bijsturing van timing en afspraken is mogelijk indien nodig.
Het aanspreekpunt van DigiPost is tijdens het volledige integratieproject de contactpersoon voor de projectmanager. Hij plant meetings met eventueel andere personen binnen DigiPost in en zorgt dat timings en afspraken worden nageleefd en gerealiseerd. De projectmanager van de klant is verantwoordelijk voor de uitvoering en opvolging van het project.
- Stap 2
Analyse
Tijdens deze fase worden de behoeften volledig in kaart gebracht en maakt de klant, ondersteund door het aanspreekpunt binnen DigiPost, een volledige functionele en technische analyse.
- Stap 3
Test en ontwikkeling
De integratie wordt op de TI-omgeving van de DigiPost-software opgezet.
Hiervoor zal DigiPost een API-key bezorgen aan de klant, als de klant daarvoor het API-aanvraag-formulier heeft doorgegeven.
De integratie met de TI-omgeving is geslaagd wanneer de klant valideert dat de gewenste informatie met alle metadata correct raadpleegbaar is in de TI-omgeving van de respectieve toepassing
- Stap 4
Productie
De integratie wordt opgezet op de productie-omgeving van de DigiPost-software.
Hiervoor zal DigiPost een API-key bezorgen aan de klant, als de klant daarvoor het API-aanvraag-formulier heeft doorgegeven.
De integratie met de productie-omgeving is geslaagd wanneer de klant valideert dat de gewenste informatie met alle metadata correct raadpleegbaar is in de productie-omgeving van de respectieve toepassing
- Stap 5
Ingebruikname
De integratie is volledig werkend.
API-documentatie
De API-documentatie is te raadplegen op: https://digipost.vlaanderen.be/backend/swagger/index.html(opent in nieuw venster)
Gebruiksvoorwaarden API
Definities
Begrippen of uitdrukkingen die in dit document met hoofdletter geschreven worden, hebben de betekenis zoals uiteengezet in dit artikel of zoals elders in dit document gedefinieerd.
Algemeen
- Het gebruik van de webservices aangeboden door Het Facilitair Bedrijf in het kader van het DigiPost (hierna webservices of API genoemd) zijn onderworpen aan een aanvraagprocedure;
- De aanvraag en de bijhorende toelating om de webservices te gebruiken:
Is steeds beperkt tot een welbepaald doel, dat vermeld is in de aanvraag;
Heeft betrekking op slechts 1 omgeving van de Klant (productie/acceptatie/test);
- Is enkel geldig voor de aanvragende Klant.
- De toelating om deze webservices te gebruiken, wordt gegeven door Het Facilitair Bedrijf. Deze toelating is beperkt in tijd en enkel geldig voor de omgeving van de aanvragende Klant. Zowel voor het gebruik van de testomgeving als voor het gebruik van de productieomgeving bedraagt de toelating 5 jaar.
Na het verstrijken van deze termijn moet er een nieuwe toelating aangevraagd worden bij Het Facilitair Bedrijf;
Het Facilitair Bedrijf kan de toelating op elk moment met onmiddellijk ingang intrekken indien zij vaststelt dat de webservice gebruiker inbreuken pleegt op de in dit document vermelde voorwaarden. In dergelijk geval zal de Klant geenszins aanspraak kunnen maken op enige schadevergoeding, van welke aard ook;
Als een Klant informatie wil ontsluiten van een andere Klant van Het Facilitair Bedrijf, dan dienen beide Klanten hierover afspraken te maken. Deze afspraken dienen voorgelegd te worden aan Het Facilitair Bedrijf.
Functionaliteiten
De webservices zijn beperkt tot de volgende functionaliteiten:
Ophalen van geaccepteerde berichten in Digipost;
Rapporteringsmogelijkheden.
Veiligheidsvoorwaarden
De hoger vermelde toelating van Het Facilitair Bedrijf wordt afhankelijk gesteld van de naleving van veiligheidsnormen:
Het gebruik van de webservices vereist de invoering van een veiligheidslogging op basis waarvan men snel en eenvoudig kan bepalen wie, in welke rol, wanneer en op welke manier toegang heeft verkregen tot de gegevens van DigiPost;
Bij gebruik van de webservices worden steeds de gepaste technische en organisationele maatregelen genomen om de veiligheid van persoonsgegevens en andere gegevens te waarborgen.
DigiPost houdt alle requests en de resulterende acties bij via de event logging;
Indien een applicatie-id wordt gebruikt, is het de verantwoordelijkheid van de Klant om een logging van de request bij te houden voor de identificatie van de actor, dit kan zowel een fysieke persoon als een systeem zijn, die de webservice gebruikt heeft. Deze loggings moeten gedurende een termijn bewaard worden die noodzakelijk is om te voldoen aan (desbetreffende) reglementaire verplichtingen. Deze termijn mag niet korter zijn dan 10 jaar op het moment van de transactie of korter dan 3 jaar op het moment van een poging tot transactie, teneinde de andere Partij eveneens toe te laten om transacties te kunnen reconstrueren;
Indien de toegang tot de oproepende applicatie niet geregeld is via het gebruikersbeheer en toegangsbeheer (IDM/ACM) van de Vlaamse overheid, dienen, als het type informatie dit vereist, minstens dezelfde veiligheidsmaatregelen, zoals gehanteerd door IDM/ACM, voorzien te worden om toegang te krijgen tot de oproepende applicatie;
Een applicatie van de Klant kan uitsluitend door DigiPost geïdentificeerd worden door een key uitgereikt door Het Facilitair Bedrijf.
Upgrades
Het Facilitair Bedrijf zal de Klant op de hoogte stellen bij upgrades van de webservices;
Het Facilitair Bedrijf kan een migratie opleggen van de bestaande webservices naar een nieuwe upgrade ervan. In dergelijk geval dient de nieuwe upgrade binnen 1 jaar vanaf de terbeschikkingstelling van de nieuwe webservice geïmplementeerd te worden;
Na deze periode van 1 jaar heeft Het Facilitair Bedrijf geen verplichting meer tot het ter beschikking stellen of het onderhouden van oudere versies van de webservices;
Het Facilitair Bedrijf licht de Klant 6 maanden op voorhand in wanneer de oudere versies van de webservices niet meer zullen ondersteund worden;
Als een Klant gebruik wil blijven maken van een oude versie van een webservice die niet langer ondersteund wordt, dan zullen de kosten hiervoor ten laste komen van deze Klant. Hiervoor wordt tijdig een kostenindicatie aangeleverd aan de Klant.
Capaciteit
De Klant verbindt zich ertoe om Het Facilitair Bedrijf voorafgaandelijk en schriftelijk te informeren over de geschatte capaciteit die nodig zal zijn voor elke afzonderlijke integratie. Als er geen capaciteit wordt doorgegeven, gaat Het Facilitair Bedrijf uit van een minimale benodigde capaciteit;
De Klant zal het Facilitair Bedrijf schriftelijk informeren omtrent elke mogelijke wijziging aan de benodigde capaciteit;
Het Facilitair Bedrijf behoudt zich het recht voor om, indien nodig, het gebruik te beperken tot de aangevraagde geschatte capaciteit zoals gedefinieerd in punt 1 van dit hoofdstuk.