API toegang
Iedere FOS-eenheid heeft z’n eigen manier van werken op vlak van ledenbeheer. Zo gebruiken verschillende eenheden naast Keeo nog een eigen ledenbeheerplatform. Om deze eenheden de kans te geven om deze eigen tools eenvoudiger te integreren met Keeo werd een gedocumenteerde API voor Keeo ontwikkeld. Hieronder gaan we dieper in op enkele aspecten van de API.
Alle bestaande endpoints zijn opgedeeld in verschillende thema’s: Members (leden), Sections (takken), Events (evenementen) & Authentication (authenticatie). Deze endpoints werden hier gedetailleerd gedocumenteerd. Naast de gedetailleerde documentatie, dient ook rekening gehouden te worden met volgende zaken:
- Het is niet mogelijk om meerdere velden te updaten via een POST request. Het updaten van een gebruiker bijvoorbeeld, dient dus veld per veld te gebeuren.
- Om de correcte namen van alle benodigde velden in Keeo te bekomen, raden we jullie aan om via de network inspector van jullie browser de gewenste velden te achterhalen. Keeo is namelijk achterliggend volledig api-based, waardoor alle requests gevolgd kunnen worden. Daarnaast is het ook belangrijk om te vermelden dat de achterliggende endpoints verschillen van degene die hierboven gedocumenteerd zijn en eenheden hier dus geen toegang toe hebben. Enkele voorbeelden van velden in Keeo:
- Voornaam: firstname
- Familienaam: lastname
- Geboortedatum: dob
- Voor verschillende requests zijn SectionId’s en/of MemberId's vereist. De SectionId kan achterhaald worden door bv. de ledenlijst van een bepaalde sectie te openen en via de network inspector te achterhalen welke SectionId gebruikt werd voor het opvragen van deze lijst. Gelijkaardig kan voor een MemberId de detailpagina van een willekeurig lid geopend worden.
Om de API van Keeo te gebruiken, heb je een sleutel nodig die je dient aan te vragen bij de stafmedewerker ICT. FOS wil zijn eenheden wel aanzetten om bewust om te gaan met privacygevoelige informatie, zoals degene in Keeo. Daarom vragen we aan eenheden om dit formulier in te vullen, met als doel bewust na te denken omtrent de dataverwerking van privacygevoelige informatie.\
Heb je vragen hieromtrent? Mail dan naar [email protected]
De API heeft een rate limit van 1000 calls per uur. Eenheden die dus bij een groot aantal leden meerdere velden wensen te wijzigen, dienen hiermee rekening te houden. Dit kan bijvoorbeeld door je requests in een wachtrij te plaatsen en vervolgens met enige vertraging uit te voeren zodat je alsnog de rate limit respecteert.
Last modified 28d ago