developer.overheid.nl

Ontwikkelaarsportaal van de Nederlandse overheid

Ga naar hoofdinhoud
Concept pagina
Deze pagina is een concept. Deze zal alleen zichtbaar zijn in de ontwikkelomgeving en uitgesloten worden van de productie build.

Interactie API

De Interactie API is het publieke contract tussen kanalen en de interactielaag van MijnServices. De API maakt het mogelijk dat kanalen (zoals MijnOverheid of een lokale MijnOmgeving) klantgerelateerde gegevens en taken uniform kunnen tonen en uitvoeren, terwijl de data en daadwerkelijke verwerking bij de verantwoordelijke dienstverlener blijven.

Uitgangspunten voor de rolverdeling​

  1. Interactiecontract, geen beheerregister
    De Interactie API is geen zaaksysteem of administratief register. De API beantwoordt de vraag: welke informatie, context en handelingsmogelijkheden moet een kanaal op dit moment aan de gebruiker tonen? Het registreren, behandelen en archiveren van dossiers blijft bij de verantwoordelijke organisatie.
  2. Uitvoering bij de bron
    Het kanaal toont de taak of context en faciliteert de interactie, maar de verwerking en definitieve statusbepaling liggen altijd bij de bronorganisatie.
  3. Context als primair concept
    Informatie en handelingen worden opgevraagd in samenhang: bijvoorbeeld taken binnen de context van een zaak of product.
  4. Recursief en samenstelbaar
    Het contract kan recursief worden toegepast: een aggregator of federatief knooppunt kan de Interactie API aanbieden aan (de BFF van) een portaal en tegelijkertijd zelf als client onderliggende Interactie API's van andere aanbieders of bronnen raadplegen (zie Positionering).

Opzet van de Interactie API​

De documentatie en het ontwerp van de Interactie API zijn opgebouwd langs de volgende onderdelen:

  • Implementatieniveaus — De drie niveaus van interactiediepte (van doorverwijzen tot embedded uitvoering) en het additieve groeimodel.
  • Portaalwissels — De gebruikers- en systeemflows bij cross-domein sessieoverdracht en herauthenticatie.
  • Positionering — Rolverdeling in het landschap (frontends, BFF's en gefedereerde ketens).
  • Kernmodule — De gedeelde contractbasis (klant- en contextquery's, foutmodellen en kern-DTO's).
  • Uitbreidingsmodules — Domeinspecifieke modules die hierop voortbouwen, te beginnen met Taken.

Contracten en specificaties​

Voor versie v0.1 is de publiceerbare specificatie beschikbaar via:

Domeinbegrippen en functionele behoeften zijn beschreven in de bijbehorende bouwstenen, zoals MijnTaken.