Bijlage Service API

De BijlageService een cruciaal onderdeel van het http://Mijnaansluiting.nl platform, is ontworpen met een sterke nadruk op gebruiksvriendelijkheid. Deze service stelt gebruikers in staat om hun bijlagen snel en efficiënt te up- en downloaden en te beheren.

Transformatie naar REST-gebaseerde Service

De overgang naar een REST-gebaseerde service heeft aanzienlijke verbeteringen met zich meegebracht:

• Meer flexibiliteit en schaalbaarheid

• Betere compatibiliteit met moderne architecturen, middleware en netwerken

Deze verbeteringen hebben een directe positieve impact op de gebruikerservaring, verkorten de doorlooptijd van aanvragen en verhogen de algehele efficiëntie van netwerkbeheer. Door deze transitie kunnen gebruikers nu profiteren van een robuustere en toekomstbestendige infrastructuur, wat resulteert in een meer gestroomlijnd en betrouwbaar aanvraagproces.

De Bijlage Service API maakt gebruik van SAS-links (Shared Access Signatures) om toegang te verlenen tot bestanden in achterliggende Blob Storage. Deze opzet zorgt ervoor dat er een duidelijk onderscheid is tussen de bijlagen zelf (als metadata-entiteiten) en de werkelijke bestanden die in Blob Storage worden opgeslagen. Hier is hoe dit werkt:

1. Bijlage als Metadata-Entiteit:

   • Elke bijlage in de API wordt vertegenwoordigd door een set van metadata. Deze metadata kan informatie bevatten zoals de bestandsnaam, het type bestand, de grootte, en de verwijzing (URL) naar het bestand in Blob Storage.

   • De bijlage zelf bevat niet het werkelijke bestand, maar fungeert als een soort 'catalogusrecord' dat aangeeft waar het bestand te vinden is en hoe het kan worden benaderd.

2. Werkelijke Bestanden in Blob Storage:

   • De werkelijke bestanden worden veilig opgeslagen in Blob Storage.

   • In plaats van het bestand rechtstreeks via de API te versturen of te ontvangen, genereert de API een SAS-link (Shared Access Signature) die beperkte toegang tot het bestand biedt.

   • Deze SAS-links worden aan de client verstrekt en geven tijdelijke, beveiligde toegang tot het specifieke bestand in Blob Storage. Dit zorgt ervoor dat alleen geautoriseerde gebruikers toegang hebben tot de bestanden.

3. Gebruik van SAS-links:

   • SAS-links bieden gecontroleerde toegang tot bestanden.

   • Dit mechanisme zorgt voor een hoge mate van veiligheid omdat de toegang tot bestanden via deze links nauwkeurig kan worden gecontroleerd en beperkt.

   • De API beheert de levenscyclus van deze SAS-links en zorgt ervoor dat alleen geldige en veilige links worden verstrekt aan geautoriseerde gebruikers of systemen.

4. Voordelen van deze Aanpak:

   • Veiligheid: Door gebruik te maken van SAS-links kan de toegang tot bestanden in Blob Storage streng worden gecontroleerd, wat risico's op onbevoegde toegang minimaliseert.

   • Schaalbaarheid: De opslag van grote bestanden in Blob Storage voorkomt dat de API zelf zwaar wordt belast met data-opslag, waardoor het systeem beter schaalbaar is.

   • Flexibiliteit: De mogelijkheid om toegang tot bestanden dynamisch te regelen via SAS-links maakt het systeem flexibel en makkelijk aanpasbaar aan verschillende beveiligings- en toegangsbehoeften.

In essentie maakt de Bijlage API gebruik van SAS-links om de werkelijke bestanden op een veilige en efficiënte manier te beheren en toegankelijk te maken, terwijl de bijlagen als metadata-entiteiten worden behandeld om de API zelf licht en snel te houden.

Met deze methode kunnen gebruikers een lijst van bijlagen in een aanvraag opvragen. Op de resultaten kan paginering worden toegepast.

Het /aanvraag/{aanvraagId}/bijlage endpoint met de GET-methode biedt de functionaliteit om een lijst van bijage items op te halen.

Bij het opvragen van een lijst van aanvragen met de GET /aanvraag/{aanvraagId}/bijlage methode, moeten de volgende url-parameters worden gebruikt om de resultaten te filteren en te pagineren:

1. aanvraagId (string): De Id van de aanvraag.

Bij het opvragen van een lijst van aanvragen met de GET /aanvraag/{aanvraagId}/bijlage methode, kunnen de volgende query-parameters worden gebruikt om de resultaten te filteren en te pagineren:

1. skip (integer, int32): Het aantal resultaten om over te slaan (voor paginering).

2. take (integer, int32): Het aantal resultaten om terug te geven (voor paginering).

Deze methode stelt gebruikers in staat om een bijlage bij een aanvraag op te halen Het aanvraagId moet in de URL worden gespecificeerd, evenals de bijlageId.

Het /aanvraag/{aanvraagId}/bijlage/{bijlageId} endpoint met {aanvraagId} en {bijlageId} met de GET-methode biedt de functionaliteit om een bijlage op te halen.

Bij het opvragen van een bijlage met de GET /aanvraag/{aanvraagId}/bijlage/{bijlageId} methode, moeten de volgende urlparameters worden gebruikt om de resultaten te filteren:

1. aanvraagId (string): De Id van de op te halen aanvraag.

2. bijlageId (string): De Id van de op te halen bijlage.

codevoorbeeld (curl):

Deze methode stelt gebruikers in staat om een verkoopdocument bij een aanvraag op te halen. Het aanvraagId moet in de URL worden gespecificeerd, evenals het verkoopDocumentId.

Het /aanvraag/{aanvraagId}/bijlage/{verkoopDocumentId} endpoint met {aanvraagId} en {verkoopDocumentId} met de GET-methode biedt de functionaliteit om een verkoopdocument op te halen.

Bij het opvragen van een verkoopdocument met de GET /aanvraag/{aanvraagId}/bijlage/{verkoopDocumentId} methode, moeten de volgende urlparameters worden gebruikt om de resultaten te filteren:

1. aanvraagId (string): De Id van de aanvraag.

2. verkoopDocumentId (string): De Id van het op te halen verkoopdocument.

codevoorbeeld (curl):

Met deze methode kunnen gebruikers een aanvraagpdf in een aanvraag opvragen. Het aanvraagId moet in de URL worden gespecificeerd.

Het /aanvraag/{aanvraagId}/aanvraagpdf endpoint met de GET-methode biedt de functionaliteit om een aanvraagpdf op te halen.

Bij het aanpassen van een aanvraag met de PATCH /aanvraag/{aanvraagid} methode, kunnen de volgende url-parameters worden gebruikt om de resultaten te filteren en te pagineren:

1. aanvraagId (string): De Id van de aanvraag.

Bij het opvragen van een aanvraagpdf met de GET /aanvraag/{aanvraagId}/aanvraagpdf methode, moeten de volgende urlparameters worden gebruikt om de resultaten te filteren:

1. aanvraagId (string): De Id van de aanvraag.

codevoorbeeld (curl):