/
REST-services voor aanvragers

REST-services voor aanvragers

Om toegang te verkrijgen tot de REST API’s van het Klant Informatiesysteem, dient een verzoek te worden ingediend via de ServiceDesk.

Inleiding

Met de REST API-functionaliteit voor Aanvragers LIP+ kunnen aanvragers uitsluitend gegevens raadplegen. Aanvragen indienen gebeurt via www.mijnaansluiting.nl; de API biedt alleen-lezen toegang tot bestaande aanvragen, bijbehorende gegevens, statusinformatie en bijlagen.

Toegang tot deze services vereist authenticatie via Microsoft Entra ID. Meer informatie vind u daarover in het hoofdstuk Authenticatie.

De aanvragen die kunnen worden opgevraagd zijn uitsluitend aanvragen die door de leden betreffende gebruikersgroep zijn ingediend, de zogenaamde “eigen aanvragen“.

Gedetailleerde beschrijving van de services

https://mijnaansluiting.atlassian.net/wiki/spaces/Wiki/pages/80019458

https://mijnaansluiting.atlassian.net/wiki/spaces/Wiki/pages/80969729

Functionele beschrijving

https://mijnaansluiting.atlassian.net/wiki/spaces/Wiki/pages/90996770

  1. Authenticatie

    • Aanvragers loggen in via Entra ID en ontvangen een autorisatietoken.

  2. Overzicht aanvragen

    • Via GET /aanvraag wordt een lijst opgevraagd met de aanvragen die gekoppeld zijn aan het account van de aanvrager.

    • Via GET /aanvraag/{aanvraagId}/aanvraag-gerelateerd wordt een lijst van gerelateerde aanvragen getoond

    • Elk item bevat onder andere een aanvraagId en status.

  3. Details per aanvraag

    • Met het aanvraagId kunnen details en betrokken aansluitobjecten (objectId) worden opgevraagd.

    • Per objectId zijn één of meer producten geselecteerd (disciplines) met elk een disciplineId.

  4. Documentatie en status

    • Aanvragers hebben toegang tot PDF-documentatie aanvraagdocument, en eventueel verkoopdocument).

    • Ook bijlagen die zijn meegeleverd bij de aanvraag zijn beschikbaar per ID.

  5. Status van producten

    • Via het objectId en disciplineId kan de status van het gekozen product worden geraadpleegd.

 

Authenticatie

Aanvraag Service API

De Aanvraag API stelt aanvragers in staat om gegevens van ingediende aanvragen in te zien.
Via deze routes kunnen objecten en geselecteerde producten worden opgevraagd, inclusief hun status en configuratie. De API biedt uitsluitend leesrechten en is beschikbaar na authenticatie via Entra ID.

Bijlage Service API

Via de Bijlage API kunnen gekoppelde bestanden worden opgehaald die bij een aanvraag zijn toegevoegd.
Dit betreft zowel losse bijlagen als de gegeneerde aanvraag-pdf en verkoopdocumenten.
Toegang tot deze endpoints is alleen mogelijk na authenticatie met client credentials via Entra ID.

Beschikbare GET-endpoints voor Aanvragers

Service

GET-operatie

 

Service

GET-operatie

 

Aanvraag Service API

/aanvraag

✅

 

/aanvraag/{aanvraagId}

✅

 

/aanvraag/{aanvraagId}/aavraag-gerelateerd

✅

 

/aanvraag/{aanvraagId}/aansluitObject

✅

 

/aanvraag/{aanvraagId}/aansluitObject/{objectId}/discipline

✅

 

/aanvraag/object/{objectId}/discipline/{disciplineId}/status

✅

Bijlage Service API

/aanvraag/{aanvraagId}/bijlage

✅

 

/aanvraag/{aanvraagId}/bijlage/{bijlageId}

✅

 

/aanvraag/{aanvraagId}/aanvraagpdf

✅

 

/aanvraag/{aanvraagId}/verkoopdocument/{verkoopDocumentId}

✅