Mijn OAuth 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 geclaimed (zie sectie "Permissies wijzigen") werden door 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 boven; sectie "Hoe kan ik me aanmelden op het het Beheerportaal?"). 

Laat ons er van uit gaan dat er voor uw organisatie wél minstens één API geïntegreerd is met het Vlaams Toegangsbeheer (ACM) - in onderstaand voorbeeld zijn dat er in totaal 5:

Bij elke API staat aangegeven welke de naam van de API is - hierop kan u doorklikken voor meer detail (zie verder) -  het type van de API (OAuth API), de status van de API, de datum van de laatste update, en tenslotte een actie-knop "Permissies wijzigen". De functionaliteiten die schuilgaan achter deze actie-knop, worden verderop toegelicht (zie sectie "Permissies wijzigen").

Bij de status van de API wordt, zoals u in bovenstaand voorbeeld kan nagaan, ook aangegeven hoeveel clients er reeds gemachtigd zijn om uw API te consumeren, alsook of en hoeveel clients uw API wensen te consumeren maar hiervoor nog op uw goedkeuring wachten. Zo kan men vaststellen dat er voor de API "Vlaams Mandatensysteem T&I" inderdaad één client is die nog wacht op goedkeuring. De API-eigenaar werd voor een goed begrip ook via mail verwittigd op het moment dat de aanvraag door de beheerder van de client werd ingediend. Dat mailtje gaat steeds uit van het generieke adres beheerportaal-noreply@vlaanderen.be, en zal er als volgt uitzien:

In het bericht zijn de coördinaten van de aanvrager opgenomen - naam en organisatie - alsook de details van de API die in uw beheer is waarop de aanvraag betrekking heeft. Voorts wordt de link meegegeven via de welke u de aanvraag kan goed- of afkeuren. Meer detail kan u desgewenst hieronder terugvinden (zie sectie "OAuth-Clients die wachten op goedkeuring").

Permissies wijzigen

Aan elke API dient exact één eigenaar te worden toegewezen: deze API-eigenaar staat in voor het beheer van de API in kwestie. Het aanpassen van de eigenaar van een API heeft vanzelfsprekend ingrijpende gevolgen, dus gelieve steeds voorzichtig om te springen met het aanpassen van eigenaarsrechten. Voorts kunnen aan een API ook één of meerdere editeerders toegewezen worden: deze gebruikers kunnen dezelfde operationele beheerstaken voor hun rekening nemen - denk bijvoorbeeld aan het goedkeuren van een aanvraag van een client die uw API wenst te consumeren - als API-eigenaars, maar worden niet als eindverantwoordelijke of primair contactpunt beschouwd.

Het eigenaarschap van één of meerdere API's van uw organisatie, kan voor een goed begrip geclaimd worden door medewerkers van uw organisatie die in het Gebruikersbeheer (IDM) geregistreerd zijn als "API-beheerder", of, indien uw organisatie in de KBO geregistreerd is, door de Wettelijke Vertegenwoordiger(s) van uw organisatie. Het aanpassen van het eigenaarschap van de API's van uw organisatie, kan worden opgenomen door medewerkers van uw organisatie die in het Gebruikersbeheer (IDM) geregistreerd zijn als "Lokale Beheerder" van uw organisatie. Meer informatie omtrent deze verschillende profielen, kan u desgewenst terugvinden onder "Hoe kan ik gemachtigd worden om API's te beheren op het Beheerportaal?" op bovenliggende pagina.

Ter illustratie: veronderstel dat u in het Beheerportaal te boek staat als API-eigenaar van de API "Vlaams Mandatensysteem T&I", maar het operationele beheer van deze API wenst te delegeren naar één van uw collega's. U wenst met andere woorden aan deze API een editeerder te koppelen. Dat kan dus door naast de naam van uw API op de actie-knop "Permissies wijzigen" te klikken. In het zoekvenster naast "Zoek gebruiker" geeft u vervolgens de coördinaten in van uw collega. U vinkt de checkbox onder "Editeer" aan naast uw collega, en klikt tenslotte op "Wijzigen":

Uw collega wordt via mail op de hoogte gebracht van de toekenning van deze Editeer-rol, en zal, als hij of zij naar het Beheerportaal surft, het bijhorende operationele takenpakket voor deze API voor zijn of haar rekening kunnen nemen. In de volgende sectie gaan we dieper in op dit concrete takenpakket - i.e. de configuratie van uw API, het reviseren van de clients die reeds gemachtigd zijn om uw API te consumeren, en het verwerken van aanvragen van clients die uw API wensen te consumeren, maar daar nog niet toe gemachtigd zijn. 

Mijn OAuth API

U klikte in het scherm "Mijn OAuth API's" op de naam van één van de API's waarvan u eigenaar dan wel editeerder bent. In onderstaand voorbeeld gaan we zo bijvoorbeeld uit van de API "Vlaams Mandatensysteem T&I". U belandt op onderstaand scherm waar u naar vier verschillende tabs kan navigeren:

We voorzien bij elk tabje graag in de nodige toelichting. U kan via onderstaande links naar de desbetreffende documentatie navigeren:

• Configuratie van de API
• OAuth-Clients die wachten op goedkeuring
• OAuth-Clients die toegang hebben
• API whitelists