REST-services voor aannemers

Het Klant Informatiesysteem (KIS) biedt aannemers een betrouwbare en actuele informatiebron voor het uitvoeren van werkzaamheden.
Via de REST API is gestructureerde toegang beschikbaar tot aanvragen, objectgegevens, bijlagen, productconfiguratie en planningsinformatie.

Alle gegevensuitwisseling verloopt conform de eisen van de Algemene Verordening Gegevensbescherming (AVG). Toegang tot persoonsgegevens is strikt afgebakend en alleen beschikbaar voor geauthenticeerde, geautoriseerde partijen met een geldige opdrachtrol. Hiermee wordt geborgd dat gevoelige informatie uitsluitend geraadpleegd wordt door uitvoerende partijen met een gerechtvaardigd belang.

De REST API ondersteunt uitsluitend leesoperaties en is bedoeld voor integratie met backoffice- of planningssystemen van aangesloten aannemers.

Authenticatie

Toegang tot de REST API vereist authenticatie via Microsoft Entra ID.
Aangemelde systemen authenticeren via de Client Credentials Flow (client_id + client_secret) en ontvangen een JWT access token.
Dit token moet worden meegegeven als Bearer bij elke API-aanroep.

Details per aanvraag

Via:

• GET /aanvraag/{aanvraagId}/aanvraag-gerelateerd
  → toont door de aanvrager gerelateerde aanvragen

• GET /aanvraag/{aanvraagId}/aansluitObject
  → retourneert de bijbehorende objectIds

• GET /aanvraag/{aanvraagId}/aansluitObject/{objectId}/discipline
  → retourneert de gekozen producten als disciplineId

• GET /aanvraag/{aanvraagId}/aansluitObject/{objectId}/discipline/{disciplineId}/question
  → toont configuratievragen per product

Documentatie en bijlagen

Per aanvraag kunnen verschillende documenten worden opgehaald:

• GET /aanvraag/{aanvraagId}/bijlage

• GET /aanvraag/{aanvraagId}/bijlage/{bijlageId}

Aanvrager- en contactgegevens

Aannemers kunnen ook gebruikersinformatie opvragen die relevant is voor de uitvoering:

• GET /aanvraag/{aanvraagId}/aanvrager
  → toont gegevens van de aanvrager

• GET /aanvraag/{aanvraagId}/contactpersoon-uitvoering
  → toont de uitvoerende contactpersoon bij de klantzijde

Planningsinformatie

Via:

kan de geplande uitvoeringsinformatie worden opgevraagd voor de aanvraag, indien beschikbaar.

Gedetailleerde beschrijving van de services

Aanvraag Service APIPreview

Bijlage Service APIPreview

User Service APIPreview

AansluitingPlanning Service ApiPreview

Functionele beschrijving

Het LIP ProcesPreview

Authenticatie

Aanvraag Service API

Aanvraag Service APIPreview

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

Bijlage Service APIPreview

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.

User Service API

User Service APIPreview

De UserService geeft aannemers toegang tot de contactgegevens van de aanvrager en de contactpersoon voor uitvoering. Deze gegevens zijn noodzakelijk voor het afstemmen van de werkzaamheden en het plannen van de aansluiting op locatie. Toegang is uitsluitend mogelijk voor geautoriseerde aannemers met een actieve opdrachtrol op de betreffende aanvraag.

AansluitPlanning Service API

AansluitingPlanning Service ApiPreview

De AansluitingPlanningService stelt aannemers in staat om geplande uitvoeringsinformatie per aanvraag op te vragen.
Dit is van belang voor het afstemmen van de uitvoering met de klant en interne werkvoorbereiding.
De service is alleen beschikbaar voor partijen die een actieve uitvoeringsrol hebben op de aanvraag.