Verschillen
Dit geeft de verschillen weer tussen de geselecteerde revisie en de huidige revisie van de pagina.
Beide kanten vorige revisie Vorige revisie Volgende revisie | Vorige revisie | ||
handleidingen:groepsadmin:api [2020/10/09 10:26] Veerle Janssens [Groepsadmin gebruiken] |
handleidingen:groepsadmin:api [2022/09/20 16:56] (huidige) Benjamin Van Bever [Jouw applicatie registreren] |
||
---|---|---|---|
Regel 1: | Regel 1: | ||
- | ====== Api ====== | + | ====== Groepsadmin-API ====== |
De groepsadministratie werkt via een REST API. Andere systemen kunnen deze REST API ook gebruiken als ze geregistreerd zijn. | De groepsadministratie werkt via een REST API. Andere systemen kunnen deze REST API ook gebruiken als ze geregistreerd zijn. | ||
Regel 6: | Regel 6: | ||
Als je anderen wil kunnen laten inloggen met een scouts en gidsen vlaanderen login op je service. Dan moet je hier niet de groepsadministratie API voor gebruiken. | Als je anderen wil kunnen laten inloggen met een scouts en gidsen vlaanderen login op je service. Dan moet je hier niet de groepsadministratie API voor gebruiken. | ||
- | Hiervoor is er de login server: https://login.scoutsengidsenvlaanderen.be/. | + | Hiervoor is er de loginserver: https://login.scoutsengidsenvlaanderen.be/. |
Technisch is dit een open-id connect server met [[https://login.scoutsengidsenvlaanderen.be/auth/realms/scouts/.well-known/openid-configuration|de volgende configuratie]]. | Technisch is dit een open-id connect server met [[https://login.scoutsengidsenvlaanderen.be/auth/realms/scouts/.well-known/openid-configuration|de volgende configuratie]]. | ||
- | Eens je je applicatie geregistreerd hebt kan je bij ons een client krijgen die je dan kan gebruiken om jouw applicatie te authenticeren. | + | Eens je je applicatie geregistreerd hebt, kan je bij ons een client krijgen die je dan kan gebruiken om jouw applicatie te authenticeren. |
- | Na authenticatie krijgt je applicatie dan enkele basis gegevens van deze gebruiker (id, gebruikersnaam, ...) | + | Na authenticatie krijgt je applicatie dan enkele basisgegevens van deze gebruiker (id, gebruikersnaam, ...) |
- | ===== Groepsadmin gebruiken ===== | + | ===== Groepsadmin-API gebruiken ===== |
- | De REST API [[specificatie staat online.|https://github.com/ScoutsGidsenVL/groepsadmin-client/blob/staging/docs/api.apib]]. | + | De REST API [[https://groepsadmin.scoutsengidsenvlaanderen.be/groepsadmin/client/docs/api.html|specificatie staat online]] ([[https://github.com/ScoutsGidsenVL/groepsadmin-client/blob/staging/docs/api.apib|broncode]]). |
De authenticatie van de groepsadministratie gebeurt met https://login.scoutsengidsenvlaanderen.be. | De authenticatie van de groepsadministratie gebeurt met https://login.scoutsengidsenvlaanderen.be. | ||
Regel 29: | Regel 29: | ||
Indien je met jouw applicatie gebruik wil maken van de login server of de groepsadministratie, moet je deze bij ons laten registreren. | Indien je met jouw applicatie gebruik wil maken van de login server of de groepsadministratie, moet je deze bij ons laten registreren. | ||
- | Dit kan je doen door een mailtje te sturen naar [[informatica@scoutsengidsenvlaanderen.be]] en daar de volgende vragen beantwoorden: | + | Dit kan je doen door dit formulier in te vullen: \\ |
- | + | https://www.scoutsengidsenvlaanderen.be/leiding/ondersteuning/groepsleiding/website-en-it/groepsadministratie/aanvraag-api-key-voor-de-groepsadministratie | |
- | * Voor welke groep doe je deze aanvraag? | + | |
- | * Wat is de naam van de applicatie? | + | |
- | * Kan je in enkele zinnen het doel van de applicatie beschrijven | + | |
- | * Wie gaat de applicatie maken? | + | |
- | * Gaan de makers van de applicatie de gegevens van de gebruikers beschermen zoals de GDRP bepaalt? | + | |
- | * Wie gaat de applicatie beheren wat zijn zijn/haar contactgegevens? | + | |
- | * Gaan de beheerders van de applicatie de gegevens van de gebruikers beschermen zoals de GDRP bepaalt? | + | |
- | * Wie gaat de applicatie gebruiken? | + | |
- | * Welke functionaliteit wordt voorzien in de applicatie? | + | |
- | * Waar gaat je applicatie beschikbaar? De authenticatie wordt beperkt tot deze urls. | + | |
- | * Gaat de applicatie een website zijn die enkel toegankelijk is via HTTPS? | + | |
- | * Welke gegevens gaan er opgehaald worden uit de API? | + | |
- | * Welke gegevens gaan er aangepast worden met de API? | + | |
- | * Welke gegevens die opgehaald zijn uit de Groepsadmin API gaan er buiten de API opgeslagen worden? | + | |
- | * Welke openid connect code flow kan je applicatie gebruiken: | + | |
- | * ''client_credentials'': voor authenticatie door servers in apps | + | |
- | * ''implicit'': voor publieke browser based apps waar broncode publiek toegankelijk is | + |