Voor wie is deze handleiding bestemd?

U heeft reeds één of meerdere REST API's van het server-naar-server type geïntegreerd met het Vlaams Toegangsbeheer (ACM). U kan nu uw API's en de clients die uw API mogen bevragen, volledig autonoom beheren in het Beheerportaal. Of dus; indien uw API geconsumeerd mag worden door een nieuwe client, kan u dit volledig autonoom inregelen in het Beheerportaal zonder dat hiervoor een tussenkomst van één van de analisten van het aansluitingsteam (integraties@vlaanderen.be) aan de orde is. De koppeling tussen uw API en de client wordt achterliggend 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:

Open

In de ACM-aanmeldschermen selecteert u één van de digitale sleutels om zich sterk te authenticeren:

Open

Indien u namens meerdere organisaties API's 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 API's 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: 

Welke acties u dient te nemen indien u op deze foutmelding onthaald wordt, leest u in onderstaand rubriekje.

Hoe kan ik gemachtigd worden om API's 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 API's wenst te beheren, in het Gebruikersbeheer gemachtigd dient te zijn: u dient in het Gebruikersbeheer voor uw organisatie over het gebruikersrecht "API-beheerder en Client-beheerder" te beschikken. 

• U dient het gebruikersrecht "API-beheerder en Client-beheerder" aan te vragen bij de "Lokale Beheerder" van uw organisatie. Een "Lokale Beheerder" is een gezaghebbende van uw organisatie die de gebruikersrechten beheert in het Gebruikersbeheer (IDM) .
  
  We voorzien daarnaast ook zelfregistratielinks via de welke u dit gebruikersrecht rechtstreeks kan aanvragen bij uw "Lokale Beheerder". Opgelet: om rechten via deze weg aan te kunnen vragen, dient er voor uw organisatie wel minstens één Lokale Beheerder geregistreerd te zijn in het Gebruikersbeheer.
  
  

  • Zelfregistratielink Entiteit van de Vlaamse Overheid

  • Zelfregistratielink Economische Actor

  • Zelfregistratielink Lokaal Bestuur

  • Zelfregistratielink instelling Onderwijs en Vorming
    
    

• Geen idee wie de Lokale Beheerder van uw organisatie is? U kan bellen naar het gratis nummer 1700 (Over 1700 ), elke werkdag van 9u tot 19u. Onze ondersteuners voorzien graag de nodige begeleiding.

Wanneer uw "Lokale Beheerder" u het recht “API-beheerder en Client-beheerder” heeft toegekend ontvangt u aansluitend een automatisch bevestigingsmailtje van noreply-gebruikersbeheer@vlaanderen.be getiteld "U hebt een recht gekregen via het Gebruikersbeheer van de Vlaamse overheid":

"Lokale Beheerders" kunnen trouwens ook gebruik maken van het Beheerportaal. Zij kunnen evenwel minder acties voor hun rekening nemen dan de eerder vermelde “API-beheerders en Client-beheerders”: Lokale Beheerders kunnen namelijk uitsluitend de eigenaar (zie "Permissies wijzigen") van een API die in beheer is van hun organisatie, aanpassen - bijvoorbeeld wanneer de vorige eigenaar uit dienst getreden is binnen de organisatie.

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 API's van zijn/haar organisatie beheren in het Beheerportaal. Wettelijke Vertegenwoordigers dienen met andere woorden geen rechten te hebben in het Gebruikersbeheer (IDM) om de API's van hun organisatie te kunnen beheren.

Ik ben aangemeld op het Beheerportaal: het startscherm

Dit is het startscherm:

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 API's. We lichten graag eerst nog de resterende scherm-componenten toe, en komen hier dadelijk op terug. Indien u meteen richting het beheer wenst te navigeren, kan u doorklikken naar "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":

Deze functionaliteit is interessant als u verschillende API's beheert namens uw organisatie, en u snel van de ene API naar de andere API 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 componenten die voor u nuttig zijn, op één locatie verzamelen.

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. Indien u meteen richting het beheer wenst te navigeren, kan u doorklikken naar "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. We lichten graag eerst nog de resterende scherm-componenten toe, en komen hier dadelijk op terug. Indien u meteen richting het beheer van uw API wenst te navigeren, kan u doorklikken naar "Overzicht Mijn API's". 

Via de knop "Mijn OAuth Clients" kan u de clients van uw organisatie beheren die API's van het server-naar-server type bevragen. Voor een nadere toelichting bij het beheer van deze clients, verwijzen we u thans graag door naar het documentatie-luikje Module OAuth Client Credentials Grant: API-Client beheren.

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 API's

U klikte in het startscherm onder "Uw Bouwstenen" op "Toegangsbeheer", vervolgens op "API- en Clientbeheer", en tenslotte op "Mijn OAuth API's". Indien u onthaald wordt op onderstaand scherm, betekent dit dat er momenteel voor uw organisatie geen API's geïntegreerd zijn met het Vlaams Toegangsbeheer (ACM), of dat de API's reeds eigendom zijn (zie “Permissies wijzigen") van andere medewerkers van uw organisatie:

Wenst u één of meerdere van uw API's te integreren met het Vlaams Toegangsbeheer (ACM)? Elke entiteit van de Vlaamse Overheid, elk Vlaams lokaal bestuur en elke leverancier die bijdraagt tot de taakstelling van de Vlaamse Overheid, kan zo'n integratie volledig kosteloos afnemen van Digitaal Vlaanderen: er wordt geen aansluitingskost in rekening gebracht noch wordt er een recurrente operationele kost gefactureerd. U mag hiervoor te allen tijde contact opnemen met ons aansluitingsteam via integraties@vlaanderen.be. 

Rechtsboven kan u via het pijltje naast de naam van de organisatie namens de welke u momenteel aangemeld bent op het Beheerportaal, desgewenst terugkeren naar het hoedanigheidsselectiescherm (zie "Hoe kan ik me aanmelden op het het Beheerportaal?"). 

Indien er voor uw organisatie wél al API's geïntegreerd zijn met het Vlaams Toegangsbeheer (ACM) - en er minstens één API is die nog niet geclaimd (zie "Permissies wijzigen") is door andere medewerkers van uw organisatie - kan u desgewenst overgaan tot het eigenlijke beheer van deze API's. Deze modaliteiten worden verder beschreven op volgende pagina:

Mijn OAuth API's

Op deze pagina: