| Status | ||||
|---|---|---|---|---|
|
Op deze pagina
| Table of Contents | ||||
|---|---|---|---|---|
|
Op onderliggende pagina’s
| Child pages (Children Display) |
|---|
1. Introductie
1.1 Doelstelling van deze pagina
Deze pagina handleiding beschrijft welke acties klanten (of hun dienstverleners) moeten zetten om zelf een OAuth-Client aan te vragen voor de connectie met de webservices van het Vastgoedintegratieplatform Vastgoedinformatieplatform (VIP). Dit proces loopt via het Beheerportaal van het Toegangsbeheer (ACM), een online webtoepassing waar medewerkers van organisaties zelf OAuth-Clients kunnen aanmaken en beheren voor de connecties met API’s van de Vlaamse overheid (die werken met het Toegangsbeheer als Identity Provider).
...
1.3 Twee verschillende scenario’s…
In de onderstaande deze handleiding maken we we onderscheid tussen 2 scenario’s:
...
Aanmaken van een Client in de T&I -omgeving (testomgeving)
In de testomgeving gebruiken we een vereenvoudigd proces voor scenario 2 (waar geen aparte goedkeuring nodig is van de klant). In beide scenario’s gebeurt ook het instellen van toegang tot het Beheerportaal volgens een vereenvoudigde procedure.
Aanmaken van een Client in PRD -omgeving (productieomgeving)
In de productieomgeving gebruiken we het volledige proces voor scenario 2 (waar wél een aparte goedkeuring nodig is van de klant). In beide scenario’s gebeurt ook het instellen van toegang tot het Beheerportaal volgens de officiële procedure.
2. Beschrijving van het proces in T&I
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
Instellen toegang tot Beheerportaal [Eenmalig]
Aanvullen
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”
...
| Info |
|---|
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”
...
| Info |
|---|
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 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.
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.
...
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”
...
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.
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
Instellen toegang tot Beheerportaal [Eenmalig]
Goedkeuren Client
2.2 Scenario 2: Dienstverlener maakt Client namens een andere organisatie (T&I)
2.2.1 Overzicht
...
2.2.2 Acties voor de dienstverlener
Instellen toegang tot Beheerportaal [Eenmalig]
Aanmaken Client
Wijzigen permissies Client [Optioneel]
Testen connectie met VIP API
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
Instellen toegang tot Beheerportaal [Eenmalig]
Goedkeuren Client
3. Beschrijving van het proces in PRD
3.1 Scenario 1: Klant maakt zelf Client voor de eigen organisatie (PRD)
3.1.1 Overzicht
...
3.1.2 Acties voor de klant
Instellen toegang tot Beheerportaal [Eenmalig]
Aanmaken Client
Wijzigen permissies Client [Optioneel]
Testen connectie met VIP API
3.1.3 Acties voor de VIP-beheerder
Instellen toegang tot Beheerportaal [Eenmalig]
Goedkeuren Client
3.2 Scenario 2: Dienstverlener maakt Client namens een andere organisatie (PRD)
3.2.1 Overzicht
...
3.2.2 Acties voor de dienstverlener
Instellen toegang tot Beheerportaal [Eenmalig]
Aanmaken Client
Wijzigen permissies Client [Optioneel]
Testen connectie met VIP API
3.2.3 Acties voor de klant
Instellen toegang tot Beheerportaal [Eenmalig]
Goedkeuren Client
Wijzigen permissies Client [Optioneel]
3.2.4 Acties voor de VIP-beheerder
Instellen toegang tot Beheerportaal [Eenmalig]
...
Verder lezen
| Child pages (Children Display) |
|---|