Dit document beschrijft de netwerkinfrastructuur, de berichtpatronen en de use cases van het Data Sharing-datamodel.
Netwerkinfrastructuur
Het HDN Platform biedt de netwerktoegang waarover aangesloten partijen, zoals Cleverbase en zijn klanten, berichten uitwisselen.
Voor deze use cases hebben de gegevensgebruikers geen clientregistratie bij Cleverbase nodig. Het HDN Platform onderhoudt namelijk zelf de API-verbinding met de diensten van Cleverbase.
Berichtpatronen
Er zijn twee patronen die hier spelen. Het eerste is request-response, en verloopt zo:
Het tweede patroon is notificatie, en verloopt zo:
Alle relevante interacties op het HDN Platform gebeuren binnen een "dossier". Dat moet vóór de eerste interactie zijn aangemaakt, en het dossiernummer moet bij elk bericht mee.
Use cases
In de use cases hieronder is de technische tussenkomst van het HDN Platform niet getekend.
Een verbinding aanvragen
Elke geautoriseerde klant mag een verbinding voor gegevensdeling aanvragen. Daarvoor is interactie met de gebruiker nodig, met ondersteuning voor HTTP-redirection, bijvoorbeeld via een webportaal of een mobiele app.
De klant mag bemiddelen voor anderen en een verbinding aanvragen om gegevens met meerdere dienstverleners te delen. De toestemming van de gebruiker legt dat voornemen en het doel ervan vast.
Brongegevens opvragen
Na het verbinden kunnen alle geautoriseerde klanten brongegevens opvragen, op de manier hieronder. Ze moeten daarbij een sleutel voor de verbinding meesturen.