Voor wie is deze handleiding bestemd?
U beheert één of meerdere toepassingen waarmee u een REST API van het server-naar-server type consumeert of wenst te consumeren én deze REST API is geïntegreerd met het Vlaams Toegangsbeheer (ACM). U kan nu in het Beheerportaal volledig autonoom uw gekoppelde client beheren, of u kan een aanvraag indienen om een met ACM geïntegreerde API te kunnen bevragen. Er is hiervoor geen tussenkomst nodig van één van de analisten van het aansluitingsteam (integraties@vlaanderen.be). De beheerder van de REST API die u wenst te bevragen, wordt via het Beheerportaal op de hoogte gebracht van uw aanvraag. Indien de beheerder uw aanvraag goedkeurt, wordt de koppeling tussen uw toepassing (client) en de API in kwestie volautomatisch verwerkt door het Vlaams Toegangsbeheer (ACM).
Waar vind ik het Beheerportaal terug?
U kan het Beheerportaal terugvinden via volgende link:
https://beheerportaal.vlaanderen.be/
Dit is voor een goed begrip de link van de productie-omgeving van het Beheerportaal. De test-omgeving van het Beheerportaal kan u desgewenst bereiken via deze link.
Hoe kan ik me aanmelden op het Beheerportaal?
Het Beheerportaal is één van de inmiddels 2.000 toepassingen van de Vlaamse Overheid die geïntegreerd zijn met het Vlaams Toegangsbeheer (ACM). U klikt op "Meld u aan" op het startscherm, en wordt doorgestuurd naar de vertrouwde ACM-aanmeldschermen:
In de ACM-aanmeldschermen selecteert u één van de digitale sleutels om zich sterk te authenticeren:
Indien u namens meerdere organisaties clients mag beheren, zal u na de authenticatie onthaald worden een hoedanigheidsselectiescherm. In dit scherm dient u de organisatie te selecteren die u wenst te vertegenwoordigen op het Beheerportaal - i.e. de organisatie waarvan u de clients wenst te beheren:
Opgelet: indien u niet gemachtigd ben om minstens één organisatie te vertegenwoordigen op het Beheerportaal, zal u op onderstaand foutmeldingsscherm onthaald worden:
Hoe deze foutmelding gemitigeerd kan worden, leest u in onderstaand rubriekje.
Hoe kan ik gemachtigd worden om clients te beheren op het Beheerportaal?
Het Beheerportaal is niet enkel met het Vlaams Toegangsbeheer (ACM) geïntegreerd, maar ook met het Vlaams Gebruikersbeheer (IDM). Dat betekent dat u, indien u namens uw organisatie één of meerdere clients wenst te beheren, in het Gebruikersbeheer gemachtigd dient te zijn: u dient in het Gebruikersbeheer voor uw organisatie over het gebruikersrecht "API-beheerder" of "Lokale Beheerder" (zie verder) te kunnen beschikken. Indien u namens uw organisatie wil optreden als API-beheerder, dient u dus contact op te nemen met één van de Lokale Beheerders van uw organisatie*. Voor een goed begrip: met "Lokale Beheerder" verwijzen we naar de gezaghebbenden van uw organisatie die uw organisatie en de gebruikersrechten die in uw organisatie toegekend zijn, beheren in het Gebruikersbeheer (IDM). Meer informatie over Lokale Beheerders - o.a. over hoe u als medewerker de coördinaten van de Lokale Beheerder van uw organisatie kan terugvinden - kan u desgewenst raadplegen in de IDM-documentatie.
*Diezelfde "Lokale Beheerders" kunnen eveneens namens de organisatie waarvan zij Lokale Beheerder zijn in het Gebruikersbeheer (IDM), gebruik maken van het Beheerportaal. Lokale Beheerders kunnen in het Beheerportaal evenwel minder acties voor hun rekening nemen dan de eerder vermelde API-beheerders: Lokale Beheerders kunnen uitsluitend de eigenaar (zie Mijn OAuth Clients, sectie "Permissies wijzigen") van een client die in beheer is van hun organisatie, aanpassen - bijvoorbeeld wanneer de vorige eigenaar uit dienst getreden is binnen de organisatie. API-beheerders daarentegen kunnen een veel breder takenpakket voor hun rekening nemen - zoals het indienen van aanvragen om een met ACM geïntegreerde API te consumeren.
Tenslotte geldt er ook nog een apart regime voor organisaties die in de KBO geregistreerd zijn. Wie als Wettelijke Vertegenwoordiger van zo'n organisatie geregistreerd is in de KBO, kan ook standaard de clients van de organisatie in kwestie beheren in het Beheerportaal. Wettelijke Vertegenwoordigers dienen met andere woorden niet expliciet gemachtigd te zijn in het Gebruikersbeheer (IDM) teneinde de clients van hun organisatie te kunnen beheren - in tegenstelling tot Lokale Beheerders en API-beheerders. Wettelijke Vertegenwoordigers kunnen daarenboven precies dezelfde acties voor hun rekening nemen als de eerder vermelde API-beheerders - i.e. een breder takenpakket dan de Lokale Beheerders.
Kort samengevat: er zijn drie gebruikerscategorieën die namens een organisatie clients kunnen beheren in het Beheerportaal: API-beheerders (machtiging via IDM), Lokale Beheerders (machtiging via IDM) en Wettelijke Vertegenwoordigers (de facto gemachtigd in de KBO). API-beheerders en Wettelijke Vertegenwoordigers kunnen in het Beheerportaal meer acties voor hun rekening nemen dan Lokale Beheerders - zo kunnen Lokale Beheerders bijvoorbeeld géén aanvragen indienen om een met ACM geïntegreerde API te consumeren: dat privilege is voorbehouden voor API-beheerders en Wettelijke Vertegenwoordigers.
Ik ben aangemeld op het Beheerportaal: het startscherm
U wordt onthaald op volgend scherm:
Rechtsboven kan u nagaan namens welke organisatie u aangemeld bent op het Beheerportaal. In bovenstaand voorbeeld is gebruiker "Michiel" aangemeld namens de organisatie "Agentschap Facilitair Bedrijf". Indien u op het pijltje naast de naam van organisatie ("Agentschap Facilitair Bedrijf") klikt, kan u...
- Navigeren naar Mijn Burgerprofiel
- Navigeren naar e-loketondernemers.be
- Wisselen van account: via deze knop kan u op eenvoudige wijze terugkeren naar het hoedanigheidsselectiescherm (zie boven; sectie "Hoe kan ik me aanmelden op het het Beheerportaal?")
- Afmelden: via deze knop kan u uw lopende sessie op het Beheerportaal beëindigen
Onder "Uw Bouwstenen" in het startscherm kan u de optie "Toegangsbeheer" zien: klik op deze knop als u wil overgaan tot het beheren van uw clients. We lichten graag eerst nog de resterende scherm-componenten toe, en komen hier dadelijk op terug (zie sectie "Overzicht componenten binnen Toegangsbeheer").
Onder "Recente componenten" kan u op eenvoudige wijze doorklikken naar de componenten die u recent geraadpleegd of bewerkt heeft in het Beheerportaal. Indien u zich voor de eerste maal aanmeldt op het Beheerportaal, zullen hier vanzelfsprekend nog geen knopjes getoond worden. Indien u in het verleden wel reeds componenten heeft geraadpleegd of bewerkt, worden deze op overzichtelijke wijze getoond onder "Recente componenten" - bijvoorbeeld:
Tenslotte: onder "Uw Favorieten" kan u desgewenst uw gepersonaliseerde Beheerportaal-dashboard opmaken. Dat kan door de slider naast één van de componenten die verderop aan bod komen, naar rechts te schuiven - bijvoorbeeld:
Er verschijnt vervolgens een inline frame waar u aan de pagina die u aan uw favorieten wenst toe te voegen, een naam kan geven. Ter illustratie:
Indien u dan terug naar het startscherm navigeert, zal de bewuste pagina getoond worden onder "Uw Favorieten" onder de naam die u daar in het frame aan gaf:
Deze functionaliteit is bijzonder interessant als u verschillende clients beheert namens uw organisatie, en u snel van de ene client naar de andere client wenst te navigeren. Merk bovendien op dat, naarmate de scope van het Beheerportaal verder uitdijt (zie ook Beheerportaal: missie), deze functionaliteit aan belang wint: door een 'dashboard op maat' samen te stellen onder "Uw Favorieten", kan u alle de componenten die voor u nuttig zijn, op één locatie capteren.
Overzicht componenten binnen Toegangsbeheer
U klikte in het startscherm onder "Uw Bouwstenen" op "Toegangsbeheer". U wordt onthaald op deze pagina:
Via de knop "API- en Clientbeheer" kan u de API's en clients van uw organisatie beheren. We lichten graag eerst nog de resterende scherm-componenten toe, en komen hier dadelijk op terug (zie sectie "API- en Clientbeheer").
Via de knop "Documentatie" kan u desgewenst de technische documentatie van het Beheerportaal raadplegen. Gradueel zal via dit kanaal ook verdere (functionele en technische) documentatie gedeeld worden:
Als u op de knop "Documentatie voor het beheerportaal" klikt, en in onderstaand scherm vervolgens op "V1 docs", zal de technische documentatie in een nieuw tabblad geopend worden. Merk op dat deze documentatie de algemene architectuur van het Beheerportaal en de achterliggende technische concepten duidt - dit is geen handleiding voor het eigenlijke gebruik van het platform: daarvoor dient de documentatie die u momenteel aan het doornemen bent.
API- en Clientbeheer
U klikte in het startscherm onder "Uw Bouwstenen" op "Toegangsbeheer", en in het daaropvolgende scherm op "API- en Clientbeheer". U wordt onthaald op volgend scherm:
Via de knop "Mijn OAuth API's" kan u de API's van uw organisatie beheren die geïntegreerd zijn met het Vlaams Toegangsbeheer (ACM). Voor een nadere toelichting bij het beheer van deze API's, verwijzen we u thans graag door naar het documentatie-luikje Module OAuth Client Credentials Grant: API beheren.
Via de knop "Mijn OAuth Clients" kan u dan effectief de clients van uw organisatie beheren. We lichten graag eerst nog de resterende scherm-componenten toe, en komen hier dadelijk op terug (zie sectie "Overzicht Mijn OAuth Clients").
Via de knop "OAuth Documentatie" tenslotte kan u de OAuth API-documentatie raadplegen. U wordt onthaald op volgend scherm:
Momenteel kan u hier raadplegen:
- V1 YAML Specificaties:
- V1 Specificaties Online:
- V1 Release Notes:
Overzicht Mijn OAuth Clients
U klikte in het startscherm onder "Uw Bouwstenen" op "Toegangsbeheer", vervolgens op "API- en Clientbeheer", en tenslotte op "Mijn OAuth Clients". Indien u onthaald wordt op onderstaand scherm, betekent dit dat er momenteel voor uw organisatie geen clients geïntegreerd zijn met het Vlaams Toegangsbeheer (ACM), of dat de clients reeds geclaimed (zie Mijn OAuth Clients, sectie "Permissies wijzigen") werden door andere medewerkers van uw organisatie:
U kan desgewenst via de knop "Nieuwe OAuth client aanmaken" een nieuwe client aanmaken voor uw organisatie waarmee u één of meerdere API's die geïntegreerd zijn met het Toegangsbeheer (ACM), kan consumeren. Deze modaliteiten worden verder beschreven op volgende pagina:
Indien er voor uw organisatie wél al clients geïntegreerd zijn met het Vlaams Toegangsbeheer (ACM) - en er minstens één client is die nog niet geclaimed (zie Mijn OAuth Clients, sectie "Permissies wijzigen") is door andere medewerkers van uw organisatie - kan u desgewenst overgaan tot het eigenlijke beheer van deze clients. Deze modaliteiten worden verder beschreven op volgende pagina:
Op deze pagina:
| Relevante pagina's |
|---|
Vragen of suggesties, contacteer ons via: integraties@vlaanderen.be
