Mijn OAuth API's
- Alessia Krioutchkova (Deactivated)
- Michiel Van Cauwenberge
- Toon Van Camp
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 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?").
Laat ons er van uit gaan dat er voor uw organisatie wél minstens één API geïntegreerd is met het Vlaams Toegangsbeheer (ACM) en deze API nog niet geclaimd is door andere medewerkers van uw organisatie (zie "Permissies wijzigen") - 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 "Mijn OAuth API") - 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 "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 bevragen, alsook of en hoeveel clients uw API wensen te bevragen 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 info hieromtrent kan u terugvinden onder "OAuth-Clients die wachten op goedkeuring".
Permissies wijzigen
Eigenaars en editeerders aanduiden
Aan elke API dient exact één eigenaar te worden toegewezen: deze API-eigenaar staat in voor het beheer van de API in kwestie en is het primaire aanspreekpunt van de API. Eenmaal aan een API een eigenaar is toegewezen, kan deze niet opgeëist worden door een andere medewerker van de organisatie. Het aanpassen van de eigenaar van een API heeft vanzelfsprekend ingrijpende gevolgen, dus gelieve steeds voorzichtig om te springen met het aanpassen van eigenaarsrechten.
Aan een API kunnen door de eigenaar 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 bevragen - als API-eigenaars, maar zijn geen aanspreekpunt. Editeerders ontvangen derhalve geen updates of bevestigingsmailtjes uit het Beheerportaal; eigenaars wél.
Wie komt in aanmerking om als eigenaar of editeerder van een API ingesteld te worden? Dat zijn die medewerkers van uw organisatie die in het Gebruikersbeheer (IDM) geregistreerd zijn als “API-beheerder en Client-beheerder”. Hoe die registratie precies plaatsvindt, kan u op deze pagina terugvinden.
Eigenaars en editeerders aanpassen
Eigenaars van API’s kunnen desgewenst editeerders toevoegen of verwijderen, of een nieuwe eigenaar aanduiden in het Beheerportaal. Als de eigenaar bijvoorbeeld op het punt staat om de organisatie te verlaten, is het zonder meer aangewezen dat hij/zij een nieuwe eigenaar aanstelt. Als de eigenaar dat toch vergeten zou zijn, kan één van de medewerkers van de organisatie die in het Gebruikersbeheer (IDM) geregistreerd is als “Lokale Beheerder”, dat ook nog steeds doen.
Voor het toekennen van gebruikersrechten of om te weten wie uw Lokale Beheerder is, kunt u bellen naar het gratis nummer 1700 (Over 1700 ), elke werkdag van 9u tot 19u. Druk keuze 5: andere vragen. Bellen vanuit het buitenland kan ook, maar is niet gratis. Bel daarvoor naar +32 2 553 1700.
Praktijkvoorbeeldje
Veronderstel dat u in het Beheerportaal eigenaar bent van de API "Voorbeeld API": u ontvangt alle communicatie omtrent deze API en u neemt het beheer van deze API voor uw rekening. Echter geeft u er de voorkeur aan om dat beheer te delegeren naar één van uw collega’s. U wenst met andere woorden aan deze API een editeerder te koppelen.
Het eerste wat u dient te controleren, is of uw collega in het Gebruikersbeheer (IDM) geregistreerd is als “API-beheerder en Client-beheerder”. Als dat gebeurd is, navigeert u naar het Beheerportaal. Naast de naam van uw API klikt u op de actie-knop "Permissies wijzigen". 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":
De volgende keer dat uw collega naar het Beheerportaal surft, zal hij/zij deze API nu ook effectief kunnen beheren.
Mijn OAuth API
U klikte in het scherm "Mijn OAuth API's" op de naam van één van de API's waarvan u eigenaar of editeerder bent. 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 verschillende pagina’s navigeren:
API whitelists (deze pagina is momenteel onder constructie!)
Op deze pagina:
Heeft u vragen of wenst u telefonische ondersteuning?
Voor het toekennen van gebruikersrechten en om te weten wie uw Lokale Beheerder is, kunt u bellen naar het gratis nummer 1700 (Over 1700 ), elke werkdag van 9u tot 19u. Druk keuze 5: andere vragen.
Bellen vanuit het buitenland kan ook, maar is niet gratis. Bel daarvoor naar +32 2 553 1700.
