Document toolboxDocument toolbox

2. Beschrijving van het proces in T&I (testomgeving)

Owned by Sammy Roos (Unlicensed)
Last updated: 31 Oct, 2022
13 min read

sTATUS: in review

Op deze pagina

2.1 Scenario 1: Klant maakt zelf Client voor de eigen organisatie (T&I)

2.1.1 Overzicht

2.1.2 Acties voor de klant

2.1.2.1 Instellen toegang tot Beheerportaal [Eenmalig]

Dit is in principe een eenmalige actie. Eens je rechten hebt voor je organisatie, moet je dit niet opnieuw doen.

Om toegang te hebben tot het de testomgeving van het Beheerportaal (en de juiste module “API- en Clientbeheer”) moet je binnen je organisatie over het gebruikersrecht “API-beheerder” beschikken in de testomgeving van het Gebruikersbeheer van de Vlaamse overheid (IDM-T&I).

Omdat er in de testomgeving van het Gebruikersbeheer geen uitgebreid netwerk van “lokale beheerders” (= personen die zijn aangeduid binnen een organisatie om rechten te beheren in het Gebruikersbeheer) bestaat, hebben we ervoor gekozen om in de testomgeving zelf de gebruikersrechten toe te kennen.

  • Stuur daarom je aanvraag voor het “API-beheerder”-recht in de testomgeving naar vastgoedinformatieplatform@vlaanderen.be. Vermeld daarbij zeker het rijksregisternummer van de persoon in kwestie en de organisatie waarvoor ze het recht nodig hebben.

Pas nadat je het recht “API-beheerder” hebt kan je de overige stappen in deze handleiding uitvoeren.

2.1.2.2 Aanmaken Client

  • Ga naar het Beheerportaal in T&I.

  • Meld aan met een digitale sleutel naar keuze. Indien je rechten hebt voor meerdere organisaties, zal je ook moeten kiezen voor welke organisatie je wil aanmelden.

  • Als het de eerste keer is dat je aanmeldt in het Beheerportaal ga je initieel weinig informatie zien staan op het Startscherm. Klik op onder “Uw Bouwstenen” op “Toegangsbeheer”.

Enkel bij de eerste keer aanmelden moet je deze weg volgen. Vanaf de volgende keer ga je rechtstreeks een “recente component” of een “favoriet” kunnen openen vanop het Startscherm, wat veel snellere navigatie is.

  • Je krijgt een overzicht van beschikbare componenten binnen de bouwsteen Toegangsbeheer. Klik op “API- en Clientbeheer”.

  • Je krijgt een overzicht van beschikbare acties binnen de component “API- en Clientbeheer”. Klik op “Mijn OAuth-Clients”.

TIP: je kan binnen het Beheerportaal bepaalde pagina’s als “Favoriet” in te stellen (via de slider aan de rechtzijde in b.v. bovenstaande screenshot). Hierdoor gaat de pagina in kwestie onderaan je Startpagina als favoriet staan zodat je veel sneller naar deze pagina kan navigeren in de toekomst. Je kan dit b.v. doen met “Mijn OAuth Clients”, maar ook met een pagina van een specifieke Client of API.

  • Je bevindt je op een overzicht van je bestaande OAuth-Clients (verspreid over 3 tabbladen). Klik op “Nieuwe OAuth Client aanmaken”.

  • Vul de verplichte gegevens in:

    • Geef een gebruiksvriendelijke naam aan de Client. Dit is de naam die in de logging van het VIP-platform te zien zal zijn.

    • Duidt de organisatie aan die eigenaar is van de Client. In dit scenario mag je je eigen organisatie gewoon laten staan.

    • Selecteer een persoon als eigenaar van de Client. Je kan kiezen uit alle personen die “API-beheerder” zijn voor jouw organisatie. Indien er maar één “API-beheerder” is voor jouw organisatie, dan wordt deze automatisch geselecteerd en is deze niet wijzigbaar (zoals in onderstaande screenshot).

  • Kies voor “Publieke JWK” (JSON Web Key) als authenticatiemethode en copy paste je publieke JWK (enkel het publieke deel van de sleutel, niet het private deel) in het venster. Indien gewenst kan je meerdere JWK’s toevoegen door op “nieuw toevoegen” te klikken.

  • Klik op “Koppelen aan een nieuwe OAuth API”.

  • Geef de referentie in van de VIP-API (“dv-vip-api-test”) en klik op “Vraag aan”. Je krijgt een bevestiging dat de koppeling is aangevraagd. Ga terug naar het aanmaakscherm via het kruisje.

  • Alle noodzakelijke velden zijn ingevuld. Klik op “Aanmaken” om het aanmaakproces te voltooien. Je Client wordt aangemaakt en staat nu onder de Clients “Voor eigen organisatie”. De status is “Actief”, maar je hebt nog “1 wachtende API” (je koppeling met de VIP API wacht namelijk nog op goedkeuring)

2.1.2.3 Wijzigen permissies Client [Optioneel]

Dit is een optionele stap. Als de persoon die de Client heeft aangemaakt in de vorige stap de enige persoon is die de Client moet kunnen zien/beheren, mag je deze stap overslaan.

  • In het overzicht van “Mijn OAuth Clients” (tabblad “Voor eigen organisatie”), klik voor de gewenste Client op “Permissies wijzigen”

 

  • Je krijgt een overzicht van de personen die gekend zijn als API-beheerder (zowel binnen je eigen organisatie als binnen andere organisaties). Klik voor de gewenste persoon de checkbox “Editeer” aan. In principe is dit een persoon binnen je eigen organisatie.

  • Klik helemaal onderaan op “Wijzigen” om de wijzigingen in permissies effectief door te voeren

Personen met editeerrechten kunnen alle lees- en schrijfacties uitvoeren voor de Client in kwestie. Wees dus voorzichtig met wie je deze rechten geeft. In theorie kan dit ook iemand buiten je eigen organisatie zijn (waardoor je eigenlijk indirect in het scenario 2 landt: een Client beheren namens een andere organisatie).

2.1.2.4 Testen connectie met VIP API

Nadat de VIP-beheerder de Client heeft goedgekeurd (zie hieronder: Goedkeuren Client), kan je de Client onmiddellijk gebruiken om een Access Token aan te vragen en de VIP API aan te spreken.

2.1.3 Acties voor de VIP-beheerder

2.1.3.1 Instellen toegang tot Beheerportaal [Eenmalig]

Dit is in principe een eenmalige actie. Eens je rechten hebt voor je organisatie en voor de juiste API, moet je dit niet opnieuw doen.

Om toegang te hebben tot het de testomgeving van het Beheerportaal (en de juiste module “API- en Clientbeheer”) moet je binnen je organisatie over het gebruikersrecht “API-beheerder” beschikken in de testomgeving van het Gebruikersbeheer van de Vlaamse overheid (IDM-T&I). Om de VIP API (en aanvragen tot aansluiting tot de VIP API) te beheren moet je daarbovenop ook in het Beheerportaal ook “editeer”-rechten hebben tot de VIP API zelf. Deze kunnen enkel toegekend worden door de “eigenaar” of een andere “editeerder” van de VIP API in het Beheerportaal.

2.1.3.2 Goedkeuren Client

  • Ga naar het Beheerportaal in T&I

  • Meld aan met een digitale sleutel naar keuze. Indien je rechten hebt voor meerdere organisaties, ga je ook moeten kiezen voor welke organisatie je wil aanmelden.

  • Als het de eerste keer is dat je aanmeldt in het Beheerportaal ga je initieel weinig informatie zien staan op het Startscherm. Klik op onder “Uw Bouwstenen” op “Toegangsbeheer”

  • Je krijgt een overzicht van beschikbare componenten binnen de bouwsteen Toegangsbeheer. Klik op “API- en Clientbeheer”

  • Je krijgt een overzicht van beschikbare acties binnen de component “API- en Clientbeheer”. Klik op “Mijn API’s”

  • Je krijgt een overzicht van de API’s waartoe je toegang hebt (waarvan je eigenaar of editeerder bent). Open de VIP API. Je krijgt onmiddellijk ook een indicatie dat er een Client wacht op goedkeuring (“1 wachtende Client”).

  • Je bevindt je nu in de detailview van de VIP API. Klik op het tabblad “OAuth-Clients die wachten op goedkeuring”

  • Je krijgt een overzicht van Clients die wachten op goedkeuring. Open de Client die je wil goedkeuren

  • Bekijk de aanvraag, pas eventueel de toegelaten scopes aan en klik op “Aanvaarden”

De Client is nu goedgekeurd. De klant kan nu testen of hij connectie heeft met de VIP API (zie boven: Testen connectie met VIP API)

2.2 Scenario 2: Dienstverlener maakt Client namens een andere organisatie (T&I)

2.2.1 Overzicht

2.2.2 Acties voor de dienstverlener

2.2.2.1 Instellen toegang tot Beheerportaal [Eenmalig]

Dit is in principe een eenmalige actie. Eens je rechten hebt voor je organisatie, moet je dit niet opnieuw doen.

Om toegang te hebben tot de testomgeving van het Beheerportaal (en de juiste module “API- en Clientbeheer”) moet je binnen je organisatie over het gebruikersrecht “API-beheerder” beschikken in de testomgeving van het Gebruikersbeheer van de Vlaamse overheid (IDM-T&I).

Omdat er in de testomgeving van het Gebruikersbeheer geen uitgebreid netwerk van “lokale beheerders” (= personen die zijn aangeduid binnen een organisatie om rechten te beheren in het Gebruikersbeheer) bestaat, hebben we ervoor gekozen om in de testomgeving zelf de gebruikersrechten toe te kennen.

  • Stuur daarom je aanvraag voor het “API-beheerder”-recht in de testomgeving naar vastgoedinformatieplatform@vlaanderen.be. Vermeld daarbij zeker het rijksregisternummer van de persoon in kwestie en de organisatie waarvoor ze het recht nodig hebben

Pas nadat je het recht “API-beheerder” hebt kan je de overige stappen in deze handleiding uitvoeren.

2.2.2.2 Aanmaken Client

  • Ga naar het Beheerportaal in T&I

  • Meld aan met een digitale sleutel naar keuze. Indien je rechten hebt voor meerdere organisaties, ga je ook moeten kiezen voor welke organisatie je wil aanmelden.

  • Als het de eerste keer is dat je aanmeldt in het Beheerportaal ga je initieel weinig informatie zien staan op het Startscherm. Klik op onder “Uw Bouwstenen” op “Toegangsbeheer”

  • Je krijgt een overzicht van beschikbare componenten binnen de bouwsteen Toegangsbeheer. Klik op “API- en Clientbeheer”

  • Je krijgt een overzicht van beschikbare acties binnen de component “API- en Clientbeheer”. Klik op “Mijn OAuth-Clients”

  • Je bevindt je op een overzicht van je bestaande OAuth-Clients (verspreid over 3 tabbladden). Klik op “Nieuwe OAuth Client aanmaken”

  • Vul de verplichte gegevens in:

    • Geef een gebruiksvriendelijke naam aan de Client. Dit is de naam die in de logging van het VIP-platform te zien zal zijn.

    • Kies bij “Organisatie eigenaar” voor de optie “Namens een externe organisatie (delegatie)”

    • Geef de unieke identifier in van de organisatie namens dewelke je een Client wil aanmaken

      • Voor ondernemingen: gebruik het KBO-nummer (zonder punten)

      • Voor lokale besturen: gebruik het KBO-nummer (zonder punten)

      • Voor Vlaamse overheidsorganisaties: gebruik de OVO-code

  • Vink aan dat je editeerrechten wil voor deze Client. Dit gaat ervoor zorgen dat jij als dienstverlener achteraf deze Client kan gebruiken en beheren (in naam van je klant).

  • Kies voor “Publieke JWK” (JSON Web Key) als authenticatiemethode en copy paste je publieke JWK (enkel het publieke deel van de sleutel, niet het private deel) in het venster. Indien gewenst kan je meerdere JWK’s toevoegen door op “nieuw toevoegen” te klikken.

  • Klik op “Koppelen aan een nieuwe OAuth API”.

  • Geef de referentie in van de VIP-API (“dv-vip-api-test”) en klik op “Vraag aan”. Je krijgt een bevestiging dat de koppeling is aangevraagd. Ga terug naar het aanmaakscherm via het kruisje.

  • Alle noodzakelijke velden zijn ingevuld. Klik op “Aanmaken” om het aanmaakproces te voltooien. Je Client wordt aangemaakt en staat nu onder de Clients “In beheer voor andere organisaties”. De status is “Actief”, maar je hebt nog “1 wachtende API” (je koppeling met de VIP API wacht namelijk nog op goedkeuring)

2.2.2.3 Wijzigen permissies Client [Optioneel]

Dit is een optionele stap. Als de persoon die de Client heeft aangemaakt in de vorige stap de enige persoon is die de Client moet kunnen zien/beheren, mag je deze stap overslaan.

  • In het overzicht van “Mijn OAuth Clients” (tabblad “In beheer voor andere organisaties”), klik voor de gewenste Client op “Permissies wijzigen”

  • Je krijgt een overzicht van de personen die gekend zijn als API-beheerder (zowel binnen je eigen organisatie als binnen andere organisaties). Klik voor de gewenste persoon de checkbox “Editeer” aan. In principe is dit een persoon binnen je eigen organisatie.

  • Klik helemaal onderaan op “Wijzigen” om de wijzigingen in permissies effectief door te voeren.

2.2.2.4 Testen connectie met VIP API

Nadat de VIP-beheerder de Client heeft goedgekeurd (zie hieronder: Goedkeuren Client), kan je de Client onmiddellijk gebruiken om een Access Token aan te vragen en de VIP API aan te spreken.

2.2.3 Acties voor de klant

In T&I zijn er geen acties voor de klant in dit scenario. Er is voor gekozen om geen expliciete goedkeuring van de klant te geven in deze omgeving (om snel T&I-opstellingen te kunnen doen en om de klanten niet te overladen met administratieve handelingen in beide omgevingen).

2.2.4 Acties voor de VIP-beheerder

2.2.4.1 Instellen toegang tot Beheerportaal [Eenmalig]

Dit is in principe een eenmalige actie. Eens je rechten hebt voor je organisatie en voor de juiste API, moet je dit niet opnieuw doen.

Om toegang te hebben tot het de testomgeving van het Beheerportaal (en de juiste module “API- en Clientbeheer”) moet je binnen je organisatie over het gebruikersrecht “API-beheerder” beschikken in de testomgeving van het Gebruikersbeheer van de Vlaamse overheid (IDM-T&I). Om de VIP API (en aanvragen tot aansluiting tot de VIP API) te beheren moet je daarbovenop ook in het Beheerportaal ook “editeer”-rechten hebben tot de VIP API zelf. Deze kunnen enkel toegekend worden door de “eigenaar” of een andere “editeerder” van de VIP API in het Beheerportaal.

2.2.4.2 Goedkeuren Client

  • Ga naar het Beheerportaal in T&I

  • Meld aan met een digitale sleutel naar keuze. Indien je rechten hebt voor meerdere organisaties, ga je ook moeten kiezen voor welke organisatie je wil aanmelden.

  • Als het de eerste keer is dat je aanmeldt in het Beheerportaal ga je initieel weinig informatie zien staan op het Startscherm. Klik op onder “Uw Bouwstenen” op “Toegangsbeheer”

  • Je krijgt een overzicht van beschikbare componenten binnen de bouwsteen Toegangsbeheer. Klik op “API- en Clientbeheer”

  • Je krijgt een overzicht van beschikbare acties binnen de component “API- en Clientbeheer”. Klik op “Mijn API’s”

  • Je krijgt een overzicht van de API’s waartoe je toegang hebt (waarvan je eigenaar of editeerder bent). Open de VIP API. Je krijgt onmiddellijk ook een indicatie dat er een Client wacht op goedkeuring (“1 wachtende Client”).

  • Je bevindt je nu in de detailview van de VIP API. Klik op het tabblad “OAuth-Clients die wachten op goedkeuring”.

  • Je krijgt een overzicht van Clients die wachten op goedkeuring. Open de Client die je wil goedkeuren.

  • Bekijk de aanvraag, pas eventueel de toegelaten scopes aan en klik op “Aanvaarden”.

De Client is nu goedgekeurd. De klant kan nu testen of hij connectie heeft met de VIP API (zie boven: Testen Connectie met VIP API)